Excel.Functions class

Package:

excel

An object for evaluating Excel functions.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.2 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml

await Excel.run(async (context) => {
  // This function uses VLOOKUP to find data in the "Wrench" row on the worksheet. 
  let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4");

  // Get the value in the second column in the "Wrench" row.
  let unitSoldInNov = context.workbook.functions.vlookup("Wrench", range, 2, false);
  unitSoldInNov.load("value");

  await context.sync();
  console.log(" Number of wrenches sold in November = " + unitSoldInNov.value);
});

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

Methods

abs(number)	Returns the absolute value of a number, a number without its sign.
accrInt(issue, firstInterest, settlement, rate, par, frequency, basis, calcMethod)	Returns the accrued interest for a security that pays periodic interest.
accrIntM(issue, settlement, rate, par, basis)	Returns the accrued interest for a security that pays interest at maturity.
acos(number)	Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number.
acosh(number)	Returns the inverse hyperbolic cosine of a number.
acot(number)	Returns the arccotangent of a number, in radians in the range 0 to Pi.
acoth(number)	Returns the inverse hyperbolic cotangent of a number.
amorDegrc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)	Returns the prorated linear depreciation of an asset for each accounting period.
amorLinc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)	Returns the prorated linear depreciation of an asset for each accounting period.
and(values)	Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.
arabic(text)	Converts a Roman numeral to Arabic.
areas(reference)	Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell.
asc(text)	Changes full-width (double-byte) characters to half-width (single-byte) characters. Use with double-byte character sets (DBCS).
asin(number)	Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.
asinh(number)	Returns the inverse hyperbolic sine of a number.
atan(number)	Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.
atan2(xNum, yNum)	Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.
atanh(number)	Returns the inverse hyperbolic tangent of a number.
aveDev(values)	Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers.
average(values)	Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.
averageA(values)	Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references.
averageIf(range, criteria, averageRange)	Finds average(arithmetic mean) for the cells specified by a given condition or criteria.
averageIfs(averageRange, values)	Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.
bahtText(number)	Converts a number to text (baht).
base(number, radix, minLength)	Converts a number into a text representation with the given radix (base).
besselI(x, n)	Returns the modified Bessel function In(x).
besselJ(x, n)	Returns the Bessel function Jn(x).
besselK(x, n)	Returns the modified Bessel function Kn(x).
besselY(x, n)	Returns the Bessel function Yn(x).
beta_Dist(x, alpha, beta, cumulative, A, B)	Returns the beta probability distribution function.
beta_Inv(probability, alpha, beta, A, B)	Returns the inverse of the cumulative beta probability density function (BETA.DIST).
bin2Dec(number)	Converts a binary number to decimal.
bin2Hex(number, places)	Converts a binary number to hexadecimal.
bin2Oct(number, places)	Converts a binary number to octal.
binom_Dist_Range(trials, probabilityS, numberS, numberS2)	Returns the probability of a trial result using a binomial distribution.
binom_Dist(numberS, trials, probabilityS, cumulative)	Returns the individual term binomial distribution probability.
binom_Inv(trials, probabilityS, alpha)	Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.
bitand(number1, number2)	Returns a bitwise 'And' of two numbers.
bitlshift(number, shiftAmount)	Returns a number shifted left by shift_amount bits.
bitor(number1, number2)	Returns a bitwise 'Or' of two numbers.
bitrshift(number, shiftAmount)	Returns a number shifted right by shift_amount bits.
bitxor(number1, number2)	Returns a bitwise 'Exclusive Or' of two numbers.
ceiling_Math(number, significance, mode)	Rounds a number up, to the nearest integer or to the nearest multiple of significance.
ceiling_Precise(number, significance)	Rounds a number up, to the nearest integer or to the nearest multiple of significance.
char(number)	Returns the character specified by the code number from the character set for your computer.
chiSq_Dist_RT(x, degFreedom)	Returns the right-tailed probability of the chi-squared distribution.
chiSq_Dist(x, degFreedom, cumulative)	Returns the left-tailed probability of the chi-squared distribution.
chiSq_Inv_RT(probability, degFreedom)	Returns the inverse of the right-tailed probability of the chi-squared distribution.
chiSq_Inv(probability, degFreedom)	Returns the inverse of the left-tailed probability of the chi-squared distribution.
choose(indexNum, values)	Chooses a value or action to perform from a list of values, based on an index number.
clean(text)	Removes all nonprintable characters from text.
code(text)	Returns a numeric code for the first character in a text string, in the character set used by your computer.
columns(array)	Returns the number of columns in an array or reference.
combin(number, numberChosen)	Returns the number of combinations for a given number of items.
combina(number, numberChosen)	Returns the number of combinations with repetitions for a given number of items.
complex(realNum, iNum, suffix)	Converts real and imaginary coefficients into a complex number.
concatenate(values)	Joins several text strings into one text string.
confidence_Norm(alpha, standardDev, size)	Returns the confidence interval for a population mean, using a normal distribution.
confidence_T(alpha, standardDev, size)	Returns the confidence interval for a population mean, using a Student's T distribution.
convert(number, fromUnit, toUnit)	Converts a number from one measurement system to another.
cos(number)	Returns the cosine of an angle.
cosh(number)	Returns the hyperbolic cosine of a number.
cot(number)	Returns the cotangent of an angle.
coth(number)	Returns the hyperbolic cotangent of a number.
count(values)	Counts the number of cells in a range that contain numbers.
countA(values)	Counts the number of cells in a range that are not empty.
countBlank(range)	Counts the number of empty cells in a specified range of cells.
countIf(range, criteria)	Counts the number of cells within a range that meet the given condition.
countIfs(values)	Counts the number of cells specified by a given set of conditions or criteria.
coupDayBs(settlement, maturity, frequency, basis)	Returns the number of days from the beginning of the coupon period to the settlement date.
coupDays(settlement, maturity, frequency, basis)	Returns the number of days in the coupon period that contains the settlement date.
coupDaysNc(settlement, maturity, frequency, basis)	Returns the number of days from the settlement date to the next coupon date.
coupNcd(settlement, maturity, frequency, basis)	Returns the next coupon date after the settlement date.
coupNum(settlement, maturity, frequency, basis)	Returns the number of coupons payable between the settlement date and maturity date.
coupPcd(settlement, maturity, frequency, basis)	Returns the previous coupon date before the settlement date.
csc(number)	Returns the cosecant of an angle.
csch(number)	Returns the hyperbolic cosecant of an angle.
cumIPmt(rate, nper, pv, startPeriod, endPeriod, type)	Returns the cumulative interest paid between two periods.
cumPrinc(rate, nper, pv, startPeriod, endPeriod, type)	Returns the cumulative principal paid on a loan between two periods.
date(year, month, day)	Returns the number that represents the date in Microsoft Excel date-time code.
datevalue(dateText)	Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code.
daverage(database, field, criteria)	Averages the values in a column in a list or database that match conditions you specify.
day(serialNumber)	Returns the day of the month, a number from 1 to 31.
days(endDate, startDate)	Returns the number of days between the two dates.
days360(startDate, endDate, method)	Returns the number of days between two dates based on a 360-day year (twelve 30-day months).
db(cost, salvage, life, period, month)	Returns the depreciation of an asset for a specified period using the fixed-declining balance method.
dbcs(text)	Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters. Use with double-byte character sets (DBCS).
dcount(database, field, criteria)	Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.
dcountA(database, field, criteria)	Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.
ddb(cost, salvage, life, period, factor)	Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.
dec2Bin(number, places)	Converts a decimal number to binary.
dec2Hex(number, places)	Converts a decimal number to hexadecimal.
dec2Oct(number, places)	Converts a decimal number to octal.
decimal(number, radix)	Converts a text representation of a number in a given base into a decimal number.
degrees(angle)	Converts radians to degrees.
delta(number1, number2)	Tests whether two numbers are equal.
devSq(values)	Returns the sum of squares of deviations of data points from their sample mean.
dget(database, field, criteria)	Extracts from a database a single record that matches the conditions you specify.
disc(settlement, maturity, pr, redemption, basis)	Returns the discount rate for a security.
dmax(database, field, criteria)	Returns the largest number in the field (column) of records in the database that match the conditions you specify.
dmin(database, field, criteria)	Returns the smallest number in the field (column) of records in the database that match the conditions you specify.
dollar(number, decimals)	Converts a number to text, using currency format.
dollarDe(fractionalDollar, fraction)	Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.
dollarFr(decimalDollar, fraction)	Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.
dproduct(database, field, criteria)	Multiplies the values in the field (column) of records in the database that match the conditions you specify.
dstDev(database, field, criteria)	Estimates the standard deviation based on a sample from selected database entries.
dstDevP(database, field, criteria)	Calculates the standard deviation based on the entire population of selected database entries.
dsum(database, field, criteria)	Adds the numbers in the field (column) of records in the database that match the conditions you specify.
duration(settlement, maturity, coupon, yld, frequency, basis)	Returns the annual duration of a security with periodic interest payments.
dvar(database, field, criteria)	Estimates variance based on a sample from selected database entries.
dvarP(database, field, criteria)	Calculates variance based on the entire population of selected database entries.
ecma_Ceiling(number, significance)	Rounds a number up, to the nearest integer or to the nearest multiple of significance.
edate(startDate, months)	Returns the serial number of the date that is the indicated number of months before or after the start date.
effect(nominalRate, npery)	Returns the effective annual interest rate.
eoMonth(startDate, months)	Returns the serial number of the last day of the month before or after a specified number of months.
erf_Precise(X)	Returns the error function.
erf(lowerLimit, upperLimit)	Returns the error function.
erfC_Precise(X)	Returns the complementary error function.
erfC(x)	Returns the complementary error function.
error_Type(errorVal)	Returns a number matching an error value.
even(number)	Rounds a positive number up and negative number down to the nearest even integer.
exact(text1, text2)	Checks whether two text strings are exactly the same, and returns TRUE or FALSE. EXACT is case-sensitive.
exp(number)	Returns e raised to the power of a given number.
expon_Dist(x, lambda, cumulative)	Returns the exponential distribution.
f_Dist_RT(x, degFreedom1, degFreedom2)	Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets.
f_Dist(x, degFreedom1, degFreedom2, cumulative)	Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets.
f_Inv_RT(probability, degFreedom1, degFreedom2)	Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x.
f_Inv(probability, degFreedom1, degFreedom2)	Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x.
fact(number)	Returns the factorial of a number, equal to 123*...* Number.
factDouble(number)	Returns the double factorial of a number.
false()	Returns the logical value FALSE.
find(findText, withinText, startNum)	Returns the starting position of one text string within another text string. FIND is case-sensitive.
findB(findText, withinText, startNum)	Finds the starting position of one text string within another text string. FINDB is case-sensitive. Use with double-byte character sets (DBCS).
fisher(x)	Returns the Fisher transformation.
fisherInv(y)	Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x.
fixed(number, decimals, noCommas)	Rounds a number to the specified number of decimals and returns the result as text with or without commas.
floor_Math(number, significance, mode)	Rounds a number down, to the nearest integer or to the nearest multiple of significance.
floor_Precise(number, significance)	Rounds a number down, to the nearest integer or to the nearest multiple of significance.
fv(rate, nper, pmt, pv, type)	Returns the future value of an investment based on periodic, constant payments and a constant interest rate.
fvschedule(principal, schedule)	Returns the future value of an initial principal after applying a series of compound interest rates.
gamma_Dist(x, alpha, beta, cumulative)	Returns the gamma distribution.
gamma_Inv(probability, alpha, beta)	Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x.
gamma(x)	Returns the Gamma function value.
gammaLn_Precise(x)	Returns the natural logarithm of the gamma function.
gammaLn(x)	Returns the natural logarithm of the gamma function.
gauss(x)	Returns 0.5 less than the standard normal cumulative distribution.
gcd(values)	Returns the greatest common divisor.
geoMean(values)	Returns the geometric mean of an array or range of positive numeric data.
geStep(number, step)	Tests whether a number is greater than a threshold value.
harMean(values)	Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals.
hex2Bin(number, places)	Converts a Hexadecimal number to binary.
hex2Dec(number)	Converts a hexadecimal number to decimal.
hex2Oct(number, places)	Converts a hexadecimal number to octal.
hlookup(lookupValue, tableArray, rowIndexNum, rangeLookup)	Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify.
hour(serialNumber)	Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).
hyperlink(linkLocation, friendlyName)	Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet.
hypGeom_Dist(sampleS, numberSample, populationS, numberPop, cumulative)	Returns the hypergeometric distribution.
if(logicalTest, valueIfTrue, valueIfFalse)	Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE.
imAbs(inumber)	Returns the absolute value (modulus) of a complex number.
imaginary(inumber)	Returns the imaginary coefficient of a complex number.
imArgument(inumber)	Returns the argument q, an angle expressed in radians.
imConjugate(inumber)	Returns the complex conjugate of a complex number.
imCos(inumber)	Returns the cosine of a complex number.
imCosh(inumber)	Returns the hyperbolic cosine of a complex number.
imCot(inumber)	Returns the cotangent of a complex number.
imCsc(inumber)	Returns the cosecant of a complex number.
imCsch(inumber)	Returns the hyperbolic cosecant of a complex number.
imDiv(inumber1, inumber2)	Returns the quotient of two complex numbers.
imExp(inumber)	Returns the exponential of a complex number.
imLn(inumber)	Returns the natural logarithm of a complex number.
imLog10(inumber)	Returns the base-10 logarithm of a complex number.
imLog2(inumber)	Returns the base-2 logarithm of a complex number.
imPower(inumber, number)	Returns a complex number raised to an integer power.
imProduct(values)	Returns the product of 1 to 255 complex numbers.
imReal(inumber)	Returns the real coefficient of a complex number.
imSec(inumber)	Returns the secant of a complex number.
imSech(inumber)	Returns the hyperbolic secant of a complex number.
imSin(inumber)	Returns the sine of a complex number.
imSinh(inumber)	Returns the hyperbolic sine of a complex number.
imSqrt(inumber)	Returns the square root of a complex number.
imSub(inumber1, inumber2)	Returns the difference of two complex numbers.
imSum(values)	Returns the sum of complex numbers.
imTan(inumber)	Returns the tangent of a complex number.
int(number)	Rounds a number down to the nearest integer.
intRate(settlement, maturity, investment, redemption, basis)	Returns the interest rate for a fully invested security.
ipmt(rate, per, nper, pv, fv, type)	Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.
irr(values, guess)	Returns the internal rate of return for a series of cash flows.
isErr(value)	Checks whether a value is an error other than #N/A, and returns TRUE or FALSE.
isError(value)	Checks whether a value is an error, and returns TRUE or FALSE.
isEven(number)	Returns TRUE if the number is even.
isFormula(reference)	Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.
isLogical(value)	Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.
isNA(value)	Checks whether a value is #N/A, and returns TRUE or FALSE.
isNonText(value)	Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.
isNumber(value)	Checks whether a value is a number, and returns TRUE or FALSE.
iso_Ceiling(number, significance)	Rounds a number up, to the nearest integer or to the nearest multiple of significance.
isOdd(number)	Returns TRUE if the number is odd.
isoWeekNum(date)	Returns the ISO week number in the year for a given date.
ispmt(rate, per, nper, pv)	Returns the interest paid during a specific period of an investment.
isref(value)	Checks whether a value is a reference, and returns TRUE or FALSE.
isText(value)	Checks whether a value is text, and returns TRUE or FALSE.
kurt(values)	Returns the kurtosis of a data set.
large(array, k)	Returns the k-th largest value in a data set. For example, the fifth largest number.
lcm(values)	Returns the least common multiple.
left(text, numChars)	Returns the specified number of characters from the start of a text string.
leftb(text, numBytes)	Returns the specified number of characters from the start of a text string. Use with double-byte character sets (DBCS).
len(text)	Returns the number of characters in a text string.
lenb(text)	Returns the number of characters in a text string. Use with double-byte character sets (DBCS).
ln(number)	Returns the natural logarithm of a number.
log(number, base)	Returns the logarithm of a number to the base you specify.
log10(number)	Returns the base-10 logarithm of a number.
logNorm_Dist(x, mean, standardDev, cumulative)	Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.
logNorm_Inv(probability, mean, standardDev)	Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.
lookup(lookupValue, lookupVector, resultVector)	Looks up a value either from a one-row or one-column range or from an array. Provided for backward compatibility.
lower(text)	Converts all letters in a text string to lowercase.
match(lookupValue, lookupArray, matchType)	Returns the relative position of an item in an array that matches a specified value in a specified order.
max(values)	Returns the largest value in a set of values. Ignores logical values and text.
maxA(values)	Returns the largest value in a set of values. Does not ignore logical values and text.
mduration(settlement, maturity, coupon, yld, frequency, basis)	Returns the Macauley modified duration for a security with an assumed par value of $100.
median(values)	Returns the median, or the number in the middle of the set of given numbers.
mid(text, startNum, numChars)	Returns the characters from the middle of a text string, given a starting position and length.
midb(text, startNum, numBytes)	Returns characters from the middle of a text string, given a starting position and length. Use with double-byte character sets (DBCS).
min(values)	Returns the smallest number in a set of values. Ignores logical values and text.
minA(values)	Returns the smallest value in a set of values. Does not ignore logical values and text.
minute(serialNumber)	Returns the minute, a number from 0 to 59.
mirr(values, financeRate, reinvestRate)	Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash.
mod(number, divisor)	Returns the remainder after a number is divided by a divisor.
month(serialNumber)	Returns the month, a number from 1 (January) to 12 (December).
mround(number, multiple)	Returns a number rounded to the desired multiple.
multiNomial(values)	Returns the multinomial of a set of numbers.
n(value)	Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero).
na()	Returns the error value #N/A (value not available).
negBinom_Dist(numberF, numberS, probabilityS, cumulative)	Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success.
networkDays_Intl(startDate, endDate, weekend, holidays)	Returns the number of whole workdays between two dates with custom weekend parameters.
networkDays(startDate, endDate, holidays)	Returns the number of whole workdays between two dates.
nominal(effectRate, npery)	Returns the annual nominal interest rate.
norm_Dist(x, mean, standardDev, cumulative)	Returns the normal distribution for the specified mean and standard deviation.
norm_Inv(probability, mean, standardDev)	Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.
norm_S_Dist(z, cumulative)	Returns the standard normal distribution (has a mean of zero and a standard deviation of one).
norm_S_Inv(probability)	Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one).
not(logical)	Changes FALSE to TRUE, or TRUE to FALSE.
now()	Returns the current date and time formatted as a date and time.
nper(rate, pmt, pv, fv, type)	Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.
npv(rate, values)	Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).
numberValue(text, decimalSeparator, groupSeparator)	Converts text to number in a locale-independent manner.
oct2Bin(number, places)	Converts an octal number to binary.
oct2Dec(number)	Converts an octal number to decimal.
oct2Hex(number, places)	Converts an octal number to hexadecimal.
odd(number)	Rounds a positive number up and negative number down to the nearest odd integer.
oddFPrice(settlement, maturity, issue, firstCoupon, rate, yld, redemption, frequency, basis)	Returns the price per $100 face value of a security with an odd first period.
oddFYield(settlement, maturity, issue, firstCoupon, rate, pr, redemption, frequency, basis)	Returns the yield of a security with an odd first period.
oddLPrice(settlement, maturity, lastInterest, rate, yld, redemption, frequency, basis)	Returns the price per $100 face value of a security with an odd last period.
oddLYield(settlement, maturity, lastInterest, rate, pr, redemption, frequency, basis)	Returns the yield of a security with an odd last period.
or(values)	Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. Returns FALSE only if all arguments are FALSE.
pduration(rate, pv, fv)	Returns the number of periods required by an investment to reach a specified value.
percentile_Exc(array, k)	Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.
percentile_Inc(array, k)	Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive.
percentRank_Exc(array, x, significance)	Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.
percentRank_Inc(array, x, significance)	Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set.
permut(number, numberChosen)	Returns the number of permutations for a given number of objects that can be selected from the total objects.
permutationa(number, numberChosen)	Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.
phi(x)	Returns the value of the density function for a standard normal distribution.
pi()	Returns the value of Pi, 3.14159265358979, accurate to 15 digits.
pmt(rate, nper, pv, fv, type)	Calculates the payment for a loan based on constant payments and a constant interest rate.
poisson_Dist(x, mean, cumulative)	Returns the Poisson distribution.
power(number, power)	Returns the result of a number raised to a power.
ppmt(rate, per, nper, pv, fv, type)	Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.
price(settlement, maturity, rate, yld, redemption, frequency, basis)	Returns the price per $100 face value of a security that pays periodic interest.
priceDisc(settlement, maturity, discount, redemption, basis)	Returns the price per $100 face value of a discounted security.
priceMat(settlement, maturity, issue, rate, yld, basis)	Returns the price per $100 face value of a security that pays interest at maturity.
product(values)	Multiplies all the numbers given as arguments.
proper(text)	Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase.
pv(rate, nper, pmt, fv, type)	Returns the present value of an investment: the total amount that a series of future payments is worth now.
quartile_Exc(array, quart)	Returns the quartile of a data set, based on percentile values from 0..1, exclusive.
quartile_Inc(array, quart)	Returns the quartile of a data set, based on percentile values from 0..1, inclusive.
quotient(numerator, denominator)	Returns the integer portion of a division.
radians(angle)	Converts degrees to radians.
rand()	Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation).
randBetween(bottom, top)	Returns a random number between the numbers you specify.
rank_Avg(number, ref, order)	Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned.
rank_Eq(number, ref, order)	Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned.
rate(nper, pmt, pv, fv, type, guess)	Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR.
received(settlement, maturity, investment, discount, basis)	Returns the amount received at maturity for a fully invested security.
replace(oldText, startNum, numChars, newText)	Replaces part of a text string with a different text string.
replaceB(oldText, startNum, numBytes, newText)	Replaces part of a text string with a different text string. Use with double-byte character sets (DBCS).
rept(text, numberTimes)	Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.
right(text, numChars)	Returns the specified number of characters from the end of a text string.
rightb(text, numBytes)	Returns the specified number of characters from the end of a text string. Use with double-byte character sets (DBCS).
roman(number, form)	Converts an Arabic numeral to Roman, as text.
round(number, numDigits)	Rounds a number to a specified number of digits.
roundDown(number, numDigits)	Rounds a number down, toward zero.
roundUp(number, numDigits)	Rounds a number up, away from zero.
rows(array)	Returns the number of rows in a reference or array.
rri(nper, pv, fv)	Returns an equivalent interest rate for the growth of an investment.
sec(number)	Returns the secant of an angle.
sech(number)	Returns the hyperbolic secant of an angle.
second(serialNumber)	Returns the second, a number from 0 to 59.
seriesSum(x, n, m, coefficients)	Returns the sum of a power series based on the formula.
sheet(value)	Returns the sheet number of the referenced sheet.
sheets(reference)	Returns the number of sheets in a reference.
sign(number)	Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative.
sin(number)	Returns the sine of an angle.
sinh(number)	Returns the hyperbolic sine of a number.
skew_p(values)	Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean.
skew(values)	Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean.
sln(cost, salvage, life)	Returns the straight-line depreciation of an asset for one period.
small(array, k)	Returns the k-th smallest value in a data set. For example, the fifth smallest number.
sqrt(number)	Returns the square root of a number.
sqrtPi(number)	Returns the square root of (number * Pi).
standardize(x, mean, standardDev)	Returns a normalized value from a distribution characterized by a mean and standard deviation.
stDev_P(values)	Calculates standard deviation based on the entire population given as arguments (ignores logical values and text).
stDev_S(values)	Estimates standard deviation based on a sample (ignores logical values and text in the sample).
stDevA(values)	Estimates standard deviation based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.
stDevPA(values)	Calculates standard deviation based on an entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.
substitute(text, oldText, newText, instanceNum)	Replaces existing text with new text in a text string.
subtotal(functionNum, values)	Returns a subtotal in a list or database.
sum(values)	Adds all the numbers in a range of cells.
sumIf(range, criteria, sumRange)	Adds the cells specified by a given condition or criteria.
sumIfs(sumRange, values)	Adds the cells specified by a given set of conditions or criteria.
sumSq(values)	Returns the sum of the squares of the arguments. The arguments can be numbers, arrays, names, or references to cells that contain numbers.
syd(cost, salvage, life, per)	Returns the sum-of-years' digits depreciation of an asset for a specified period.
t_Dist_2T(x, degFreedom)	Returns the two-tailed Student's t-distribution.
t_Dist_RT(x, degFreedom)	Returns the right-tailed Student's t-distribution.
t_Dist(x, degFreedom, cumulative)	Returns the left-tailed Student's t-distribution.
t_Inv_2T(probability, degFreedom)	Returns the two-tailed inverse of the Student's t-distribution.
t_Inv(probability, degFreedom)	Returns the left-tailed inverse of the Student's t-distribution.
t(value)	Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not.
tan(number)	Returns the tangent of an angle.
tanh(number)	Returns the hyperbolic tangent of a number.
tbillEq(settlement, maturity, discount)	Returns the bond-equivalent yield for a treasury bill.
tbillPrice(settlement, maturity, discount)	Returns the price per $100 face value for a treasury bill.
tbillYield(settlement, maturity, pr)	Returns the yield for a treasury bill.
text(value, formatText)	Converts a value to text in a specific number format.
time(hour, minute, second)	Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format.
timevalue(timeText)	Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula.
today()	Returns the current date formatted as a date.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Functions object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.FunctionsData) that contains shallow copies of any loaded child properties from the original object.
trim(text)	Removes all spaces from a text string except for single spaces between words.
trimMean(array, percent)	Returns the mean of the interior portion of a set of data values.
true()	Returns the logical value TRUE.
trunc(number, numDigits)	Truncates a number to an integer by removing the decimal, or fractional, part of the number.
type(value)	Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128.
unichar(number)	Returns the Unicode character referenced by the given numeric value.
unicode(text)	Returns the number (code point) corresponding to the first character of the text.
upper(text)	Converts a text string to all uppercase letters.
usdollar(number, decimals)	Converts a number to text, using currency format.
value(text)	Converts a text string that represents a number to a number.
var_P(values)	Calculates variance based on the entire population (ignores logical values and text in the population).
var_S(values)	Estimates variance based on a sample (ignores logical values and text in the sample).
varA(values)	Estimates variance based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.
varPA(values)	Calculates variance based on the entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.
vdb(cost, salvage, life, startPeriod, endPeriod, factor, noSwitch)	Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify.
vlookup(lookupValue, tableArray, colIndexNum, rangeLookup)	Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify. By default, the table must be sorted in an ascending order.
weekday(serialNumber, returnType)	Returns a number from 1 to 7 identifying the day of the week of a date.
weekNum(serialNumber, returnType)	Returns the week number in the year.
weibull_Dist(x, alpha, beta, cumulative)	Returns the Weibull distribution.
workDay_Intl(startDate, days, weekend, holidays)	Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.
workDay(startDate, days, holidays)	Returns the serial number of the date before or after a specified number of workdays.
xirr(values, dates, guess)	Returns the internal rate of return for a schedule of cash flows.
xnpv(rate, values, dates)	Returns the net present value for a schedule of cash flows.
xor(values)	Returns a logical 'Exclusive Or' of all arguments.
year(serialNumber)	Returns the year of a date, an integer in the range 1900 - 9999.
yearFrac(startDate, endDate, basis)	Returns the year fraction representing the number of whole days between start_date and end_date.
yield(settlement, maturity, rate, pr, redemption, frequency, basis)	Returns the yield on a security that pays periodic interest.
yieldDisc(settlement, maturity, pr, redemption, basis)	Returns the annual yield for a discounted security. For example, a treasury bill.
yieldMat(settlement, maturity, issue, rate, pr, basis)	Returns the annual yield of a security that pays interest at maturity.
z_Test(array, x, sigma)	Returns the one-tailed P-value of a z-test.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

Method Details

abs(number)

Returns the absolute value of a number, a number without its sign.

abs(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the real number for which you want the absolute value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

accrInt(issue, firstInterest, settlement, rate, par, frequency, basis, calcMethod)

Returns the accrued interest for a security that pays periodic interest.

accrInt(issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, firstInterest: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, par: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, calcMethod?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

issue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's issue date, expressed as a serial date number.

firstInterest

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's first interest date, expressed as a serial date number.

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual coupon rate.

par

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's par value.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

calcMethod

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: to accrued interest from issue date = TRUE or omitted; to calculate from last coupon payment date = FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

accrIntM(issue, settlement, rate, par, basis)

Returns the accrued interest for a security that pays interest at maturity.

accrIntM(issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, par: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

issue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's issue date, expressed as a serial date number.

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual coupon rate.

par

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's par value.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

acos(number)

Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number.

acos(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the cosine of the angle you want and must be from -1 to 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

acosh(number)

Returns the inverse hyperbolic cosine of a number.

acosh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number equal to or greater than 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

acot(number)

Returns the arccotangent of a number, in radians in the range 0 to Pi.

acot(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the cotangent of the angle you want.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

acoth(number)

Returns the inverse hyperbolic cotangent of a number.

acoth(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the hyperbolic cotangent of the angle that you want.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

amorDegrc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)

Returns the prorated linear depreciation of an asset for each accounting period.

amorDegrc(cost: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, datePurchased: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, firstPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, salvage: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, period: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

cost

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the cost of the asset.

datePurchased

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the date the asset is purchased.

firstPeriod

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the date of the end of the first period.

salvage

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the salvage value at the end of life of the asset.

period

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the period.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the rate of depreciation.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

amorLinc(cost, datePurchased, firstPeriod, salvage, period, rate, basis)

Returns the prorated linear depreciation of an asset for each accounting period.

amorLinc(cost: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, datePurchased: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, firstPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, salvage: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, period: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

cost

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the cost of the asset.

datePurchased

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the date the asset is purchased.

firstPeriod

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the date of the end of the first period.

salvage

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the salvage value at the end of life of the asset.

period

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the period.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the rate of depreciation.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Year_basis : 0 for year of 360 days, 1 for actual, 3 for year of 365 days.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

and(values)

Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.

and(...values: Array<boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<boolean>;

Parameters

values

Array<boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

arabic(text)

Converts a Roman numeral to Arabic.

arabic(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Roman numeral you want to convert.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

areas(reference)

Returns the number of areas in a reference. An area is a range of contiguous cells or a single cell.

areas(reference: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

reference

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a reference to a cell or range of cells and can refer to multiple areas.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

asc(text)

Changes full-width (double-byte) characters to half-width (single-byte) characters. Use with double-byte character sets (DBCS).

asc(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a text, or a reference to a cell containing a text.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

asin(number)

Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.

asin(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the sine of the angle you want and must be from -1 to 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

asinh(number)

Returns the inverse hyperbolic sine of a number.

asinh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number equal to or greater than 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

atan(number)

Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.

atan(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the tangent of the angle you want.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

atan2(xNum, yNum)

Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.

atan2(xNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

xNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the x-coordinate of the point.

yNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the y-coordinate of the point.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

atanh(number)

Returns the inverse hyperbolic tangent of a number.

atanh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number between -1 and 1 excluding -1 and 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

aveDev(values)

Returns the average of the absolute deviations of data points from their mean. Arguments can be numbers or names, arrays, or references that contain numbers.

aveDev(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 arguments for which you want the average of the absolute deviations.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

average(values)

Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.

average(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numeric arguments for which you want the average.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

averageA(values)

Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1. Arguments can be numbers, names, arrays, or references.

averageA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 arguments for which you want the average.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

averageIf(range, criteria, averageRange)

Finds average(arithmetic mean) for the cells specified by a given condition or criteria.

averageIf(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, averageRange?: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

range

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells you want evaluated.

criteria

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average.

averageRange

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Are the actual cells to be used to find the average. If omitted, the cells in range are used.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

averageIfs(averageRange, values)

Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.

averageIfs(averageRange: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ...values: Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any> | number | string | boolean>): FunctionResult<number>;

Parameters

averageRange

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Are the actual cells to be used to find the average.

values

Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any> | number | string | boolean>

List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be used to find the average.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bahtText(number)

Converts a number to text (baht).

bahtText(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number that you want to convert.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

base(number, radix, minLength)

Converts a number into a text representation with the given radix (base).

base(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, radix: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, minLength?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number that you want to convert.

radix

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the base Radix that you want to convert the number into.

minLength

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the minimum length of the returned string. If omitted leading zeros are not added.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

besselI(x, n)

Returns the modified Bessel function In(x).

besselI(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function.

n

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the order of the Bessel function.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

besselJ(x, n)

Returns the Bessel function Jn(x).

besselJ(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function.

n

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the order of the Bessel function.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

besselK(x, n)

Returns the modified Bessel function Kn(x).

besselK(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function.

n

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the order of the function.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

besselY(x, n)

Returns the Bessel function Yn(x).

besselY(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function.

n

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the order of the function.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

beta_Dist(x, alpha, beta, cumulative, A, B)

Returns the beta probability distribution function.

beta_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, A?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, B?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value between A and B at which to evaluate the function.

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution and must be greater than 0.

beta

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution and must be greater than 0.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.

A

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional lower bound to the interval of x. If omitted, A = 0.

B

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional upper bound to the interval of x. If omitted, B = 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

beta_Inv(probability, alpha, beta, A, B)

Returns the inverse of the cumulative beta probability density function (BETA.DIST).

beta_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, A?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, B?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability associated with the beta distribution.

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution and must be greater than 0.

beta

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution and must be greater than 0.

A

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional lower bound to the interval of x. If omitted, A = 0.

B

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional upper bound to the interval of x. If omitted, B = 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bin2Dec(number)

Converts a binary number to decimal.

bin2Dec(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the binary number you want to convert.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bin2Hex(number, places)

Converts a binary number to hexadecimal.

bin2Hex(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the binary number you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bin2Oct(number, places)

Converts a binary number to octal.

bin2Oct(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the binary number you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

binom_Dist_Range(trials, probabilityS, numberS, numberS2)

Returns the probability of a trial result using a binomial distribution.

binom_Dist_Range(trials: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberS2?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

trials

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of independent trials.

probabilityS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the probability of success on each trial.

numberS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of successes in trials.

numberS2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

If provided this function returns the probability that the number of successful trials shall lie between numberS and numberS2.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

binom_Dist(numberS, trials, probabilityS, cumulative)

Returns the individual term binomial distribution probability.

binom_Dist(numberS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, trials: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

numberS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of successes in trials.

trials

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of independent trials.

probabilityS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the probability of success on each trial.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

binom_Inv(trials, probabilityS, alpha)

Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.

binom_Inv(trials: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

trials

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of Bernoulli trials.

probabilityS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the probability of success on each trial, a number between 0 and 1 inclusive.

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the criterion value, a number between 0 and 1 inclusive.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bitand(number1, number2)

Returns a bitwise 'And' of two numbers.

bitand(number1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, number2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number1

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

number2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bitlshift(number, shiftAmount)

Returns a number shifted left by shift_amount bits.

bitlshift(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, shiftAmount: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

shiftAmount

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of bits that you want to shift Number left by.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bitor(number1, number2)

Returns a bitwise 'Or' of two numbers.

bitor(number1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, number2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number1

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

number2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bitrshift(number, shiftAmount)

Returns a number shifted right by shift_amount bits.

bitrshift(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, shiftAmount: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

shiftAmount

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of bits that you want to shift Number right by.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

bitxor(number1, number2)

Returns a bitwise 'Exclusive Or' of two numbers.

bitxor(number1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, number2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number1

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

number2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal representation of the binary number you want to evaluate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ceiling_Math(number, significance, mode)

Rounds a number up, to the nearest integer or to the nearest multiple of significance.

ceiling_Math(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mode?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to round.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the multiple to which you want to round.

mode

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

When given and nonzero this function will round away from zero.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ceiling_Precise(number, significance)

Rounds a number up, to the nearest integer or to the nearest multiple of significance.

ceiling_Precise(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to round.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the multiple to which you want to round.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

char(number)

Returns the character specified by the code number from the character set for your computer.

char(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number between 1 and 255 specifying which character you want.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

chiSq_Dist_RT(x, degFreedom)

Returns the right-tailed probability of the chi-squared distribution.

chiSq_Dist_RT(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which you want to evaluate the distribution, a nonnegative number.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

chiSq_Dist(x, degFreedom, cumulative)

Returns the left-tailed probability of the chi-squared distribution.

chiSq_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which you want to evaluate the distribution, a nonnegative number.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

chiSq_Inv_RT(probability, degFreedom)

Returns the inverse of the right-tailed probability of the chi-squared distribution.

chiSq_Inv_RT(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

chiSq_Inv(probability, degFreedom)

Returns the inverse of the left-tailed probability of the chi-squared distribution.

chiSq_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability associated with the chi-squared distribution, a value between 0 and 1 inclusive.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of degrees of freedom, a number between 1 and 10^10, excluding 10^10.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

choose(indexNum, values)

Chooses a value or action to perform from a list of values, based on an index number.

choose(indexNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ...values: Array<Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number | string | boolean>;

Parameters

indexNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies which value argument is selected. indexNum must be between 1 and 254, or a formula or a reference to a number between 1 and 254.

values

Array<Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 254 numbers, cell references, defined names, formulas, functions, or text arguments from which CHOOSE selects.

Returns

Excel.FunctionResult<number | string | boolean>

Remarks

[ API set: ExcelApi 1.2 ]

clean(text)

Removes all nonprintable characters from text.

clean(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any worksheet information from which you want to remove nonprintable characters.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

code(text)

Returns a numeric code for the first character in a text string, in the character set used by your computer.

code(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text for which you want the code of the first character.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

columns(array)

Returns the number of columns in an array or reference.

columns(array: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an array or array formula, or a reference to a range of cells for which you want the number of columns.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

combin(number, numberChosen)

Returns the number of combinations for a given number of items.

combin(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of items.

numberChosen

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of items in each combination.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

combina(number, numberChosen)

Returns the number of combinations with repetitions for a given number of items.

combina(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of items.

numberChosen

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of items in each combination.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

complex(realNum, iNum, suffix)

Converts real and imaginary coefficients into a complex number.

complex(realNum: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, iNum: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, suffix?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

realNum

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the real coefficient of the complex number.

iNum

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the imaginary coefficient of the complex number.

suffix

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the suffix for the imaginary component of the complex number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

concatenate(values)

Joins several text strings into one text string.

concatenate(...values: Array<string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<string>;

Parameters

values

Array<string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 text strings to be joined into a single text string and can be text strings, numbers, or single-cell references.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

confidence_Norm(alpha, standardDev, size)

Returns the confidence interval for a population mean, using a normal distribution.

confidence_Norm(alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, size: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the significance level used to compute the confidence level, a number greater than 0 and less than 1.

standardDev

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0.

size

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the sample size.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

confidence_T(alpha, standardDev, size)

Returns the confidence interval for a population mean, using a Student's T distribution.

confidence_T(alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, size: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the significance level used to compute the confidence level, a number greater than 0 and less than 1.

standardDev

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the population standard deviation for the data range and is assumed to be known. standardDev must be greater than 0.

size

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the sample size.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

convert(number, fromUnit, toUnit)

Converts a number from one measurement system to another.

convert(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fromUnit: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, toUnit: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value in from_units to convert.

fromUnit

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the units for number.

toUnit

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the units for the result.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

cos(number)

Returns the cosine of an angle.

cos(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the cosine.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

cosh(number)

Returns the hyperbolic cosine of a number.

cosh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

cot(number)

Returns the cotangent of an angle.

cot(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the cotangent.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

coth(number)

Returns the hyperbolic cotangent of a number.

coth(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the hyperbolic cotangent.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

count(values)

Counts the number of cells in a range that contain numbers.

count(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 arguments that can contain or refer to a variety of different types of data, but only numbers are counted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

countA(values)

Counts the number of cells in a range that are not empty.

countA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 arguments representing the values and cells you want to count. Values can be any type of information.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

countBlank(range)

Counts the number of empty cells in a specified range of cells.

countBlank(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

range

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range from which you want to count the empty cells.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

countIf(range, criteria)

Counts the number of cells within a range that meet the given condition.

countIf(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

range

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells from which you want to count nonblank cells.

criteria

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the condition in the form of a number, expression, or text that defines which cells will be counted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

countIfs(values)

Counts the number of cells specified by a given set of conditions or criteria.

countIfs(...values: Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any> | number | string | boolean>): FunctionResult<number>;

Parameters

values

Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any> | number | string | boolean>

List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition in the form of a number, expression, or text that defines which cells will be counted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

coupDayBs(settlement, maturity, frequency, basis)

Returns the number of days from the beginning of the coupon period to the settlement date.

coupDayBs(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

coupDays(settlement, maturity, frequency, basis)

Returns the number of days in the coupon period that contains the settlement date.

coupDays(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

coupDaysNc(settlement, maturity, frequency, basis)

Returns the number of days from the settlement date to the next coupon date.

coupDaysNc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

coupNcd(settlement, maturity, frequency, basis)

Returns the next coupon date after the settlement date.

coupNcd(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

coupNum(settlement, maturity, frequency, basis)

Returns the number of coupons payable between the settlement date and maturity date.

coupNum(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

coupPcd(settlement, maturity, frequency, basis)

Returns the previous coupon date before the settlement date.

coupPcd(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

csc(number)

Returns the cosecant of an angle.

csc(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the cosecant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

csch(number)

Returns the hyperbolic cosecant of an angle.

csch(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the hyperbolic cosecant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

cumIPmt(rate, nper, pv, startPeriod, endPeriod, type)

Returns the cumulative interest paid between two periods.

cumIPmt(rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, endPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate.

nper

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payment periods.

pv

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value.

startPeriod

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the first period in the calculation.

endPeriod

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the last period in the calculation.

type

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the timing of the payment.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

cumPrinc(rate, nper, pv, startPeriod, endPeriod, type)

Returns the cumulative principal paid on a loan between two periods.

cumPrinc(rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, endPeriod: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate.

nper

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payment periods.

pv

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value.

startPeriod

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the first period in the calculation.

endPeriod

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the last period in the calculation.

type

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the timing of the payment.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

date(year, month, day)

Returns the number that represents the date in Microsoft Excel date-time code.

date(year: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, month: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, day: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

year

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number from 1900 or 1904 (depending on the workbook's date system) to 9999.

month

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number from 1 to 12 representing the month of the year.

day

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number from 1 to 31 representing the day of the month.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

datevalue(dateText)

Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code.

datevalue(dateText: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

dateText

string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is text that represents a date in a Microsoft Excel date format, between 1/1/1900 or 1/1/1904 (depending on the workbook's date system) and 12/31/9999.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

daverage(database, field, criteria)

Averages the values in a column in a list or database that match conditions you specify.

daverage(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

day(serialNumber)

Returns the day of the month, a number from 1 to 31.

day(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number in the date-time code used by Microsoft Excel.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

days(endDate, startDate)

Returns the number of days between the two dates.

days(endDate: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startDate: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

endDate

string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

startDate and endDate are the two dates between which you want to know the number of days.

startDate

string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

startDate and endDate are the two dates between which you want to know the number of days.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

days360(startDate, endDate, method)

Returns the number of days between two dates based on a 360-day year (twelve 30-day months).

days360(startDate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, endDate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, method?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

startDate and endDate are the two dates between which you want to know the number of days.

endDate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

startDate and endDate are the two dates between which you want to know the number of days.

method

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value specifying the calculation method: U.S. (NASD) = FALSE or omitted; European = TRUE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

db(cost, salvage, life, period, month)

Returns the depreciation of an asset for a specified period using the fixed-declining balance method.

db(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, period: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, month?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

cost

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the initial cost of the asset.

salvage

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the salvage value at the end of the life of the asset.

life

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).

period

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the period for which you want to calculate the depreciation. Period must use the same units as Life.

month

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of months in the first year. If month is omitted, it is assumed to be 12.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dbcs(text)

Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters. Use with double-byte character sets (DBCS).

dbcs(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a text, or a reference to a cell containing a text.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

dcount(database, field, criteria)

Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.

dcount(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dcountA(database, field, criteria)

Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.

dcountA(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ddb(cost, salvage, life, period, factor)

Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.

ddb(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, period: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, factor?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

cost

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the initial cost of the asset.

salvage

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the salvage value at the end of the life of the asset.

life

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).

period

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the period for which you want to calculate the depreciation. Period must use the same units as Life.

factor

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the rate at which the balance declines. If Factor is omitted, it is assumed to be 2 (the double-declining balance method).

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dec2Bin(number, places)

Converts a decimal number to binary.

dec2Bin(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal integer you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dec2Hex(number, places)

Converts a decimal number to hexadecimal.

dec2Hex(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal integer you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dec2Oct(number, places)

Converts a decimal number to octal.

dec2Oct(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the decimal integer you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

decimal(number, radix)

Converts a text representation of a number in a given base into a decimal number.

decimal(number: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, radix: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number that you want to convert.

radix

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the base Radix of the number you are converting.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

degrees(angle)

Converts radians to degrees.

degrees(angle: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

angle

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians that you want to convert.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

delta(number1, number2)

Tests whether two numbers are equal.

delta(number1: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, number2?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number1

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the first number.

number2

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the second number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

devSq(values)

Returns the sum of squares of deviations of data points from their sample mean.

devSq(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 arguments, or an array or array reference, on which you want DEVSQ to calculate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dget(database, field, criteria)

Extracts from a database a single record that matches the conditions you specify.

dget(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number | boolean | string>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number | boolean | string>

Remarks

[ API set: ExcelApi 1.2 ]

disc(settlement, maturity, pr, redemption, basis)

Returns the discount rate for a security.

disc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

pr

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's price per $100 face value.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dmax(database, field, criteria)

Returns the largest number in the field (column) of records in the database that match the conditions you specify.

dmax(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dmin(database, field, criteria)

Returns the smallest number in the field (column) of records in the database that match the conditions you specify.

dmin(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dollar(number, decimals)

Converts a number to text, using currency format.

dollar(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, decimals?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number, a reference to a cell containing a number, or a formula that evaluates to a number.

decimals

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of digits to the right of the decimal point. The number is rounded as necessary; if omitted, Decimals = 2.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

dollarDe(fractionalDollar, fraction)

Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.

dollarDe(fractionalDollar: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fraction: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

fractionalDollar

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number expressed as a fraction.

fraction

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the integer to use in the denominator of the fraction.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dollarFr(decimalDollar, fraction)

Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.

dollarFr(decimalDollar: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fraction: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

decimalDollar

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a decimal number.

fraction

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the integer to use in the denominator of a fraction.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dproduct(database, field, criteria)

Multiplies the values in the field (column) of records in the database that match the conditions you specify.

dproduct(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dstDev(database, field, criteria)

Estimates the standard deviation based on a sample from selected database entries.

dstDev(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dstDevP(database, field, criteria)

Calculates the standard deviation based on the entire population of selected database entries.

dstDevP(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dsum(database, field, criteria)

Adds the numbers in the field (column) of records in the database that match the conditions you specify.

dsum(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

duration(settlement, maturity, coupon, yld, frequency, basis)

Returns the annual duration of a security with periodic interest payments.

duration(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, coupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

coupon

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual coupon rate.

yld

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual yield.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dvar(database, field, criteria)

Estimates variance based on a sample from selected database entries.

dvar(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

dvarP(database, field, criteria)

Calculates variance based on the entire population of selected database entries.

dvarP(database: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, field: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

database

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that makes up the list or database. A database is a list of related data.

field

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is either the label of the column in double quotation marks or a number that represents the column's position in the list.

criteria

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells that contains the conditions you specify. The range includes a column label and one cell below the label for a condition.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ecma_Ceiling(number, significance)

Rounds a number up, to the nearest integer or to the nearest multiple of significance.

ecma_Ceiling(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to round.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the multiple to which you want to round.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

edate(startDate, months)

Returns the serial number of the date that is the indicated number of months before or after the start date.

edate(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, months: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the start date.

months

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of months before or after startDate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

effect(nominalRate, npery)

Returns the effective annual interest rate.

effect(nominalRate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, npery: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

nominalRate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the nominal interest rate.

npery

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of compounding periods per year.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

eoMonth(startDate, months)

Returns the serial number of the last day of the month before or after a specified number of months.

eoMonth(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, months: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the start date.

months

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of months before or after the startDate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

erf_Precise(X)

Returns the error function.

erf_Precise(X: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

X

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the lower bound for integrating ERF.PRECISE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

erf(lowerLimit, upperLimit)

Returns the error function.

erf(lowerLimit: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, upperLimit?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

lowerLimit

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the lower bound for integrating ERF.

upperLimit

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the upper bound for integrating ERF.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

erfC_Precise(X)

Returns the complementary error function.

erfC_Precise(X: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

X

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the lower bound for integrating ERFC.PRECISE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

erfC(x)

Returns the complementary error function.

erfC(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the lower bound for integrating ERF.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

error_Type(errorVal)

Returns a number matching an error value.

error_Type(errorVal: string | number | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

errorVal

string | number | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the error value for which you want the identifying number, and can be an actual error value or a reference to a cell containing an error value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

even(number)

Rounds a positive number up and negative number down to the nearest even integer.

even(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to round.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

exact(text1, text2)

Checks whether two text strings are exactly the same, and returns TRUE or FALSE. EXACT is case-sensitive.

exact(text1: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, text2: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

text1

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the first text string.

text2

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the second text string.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

exp(number)

Returns e raised to the power of a given number.

exp(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the exponent applied to the base e. The constant e equals 2.71828182845904, the base of the natural logarithm.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

expon_Dist(x, lambda, cumulative)

Returns the exponential distribution.

expon_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, lambda: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value of the function, a nonnegative number.

lambda

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the parameter value, a positive number.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

f_Dist_RT(x, degFreedom1, degFreedom2)

Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets.

f_Dist_RT(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function, a nonnegative number.

degFreedom1

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

degFreedom2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

f_Dist(x, degFreedom1, degFreedom2, cumulative)

Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets.

f_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function, a nonnegative number.

degFreedom1

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

degFreedom2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

f_Inv_RT(probability, degFreedom1, degFreedom2)

Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x.

f_Inv_RT(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive.

degFreedom1

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

degFreedom2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

f_Inv(probability, degFreedom1, degFreedom2)

Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x.

f_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom1: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom2: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability associated with the F cumulative distribution, a number between 0 and 1 inclusive.

degFreedom1

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numerator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

degFreedom2

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the denominator degrees of freedom, a number between 1 and 10^10, excluding 10^10.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

fact(number)

Returns the factorial of a number, equal to 123*...* Number.

fact(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the nonnegative number you want the factorial of.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

factDouble(number)

Returns the double factorial of a number.

factDouble(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which to return the double factorial.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

false()

Returns the logical value FALSE.

false(): FunctionResult<boolean>;

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

find(findText, withinText, startNum)

Returns the starting position of one text string within another text string. FIND is case-sensitive.

find(findText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, withinText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startNum?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

findText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text you want to find. Use double quotes (empty text) to match the first character in withinText; wildcard characters not allowed.

withinText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text containing the text you want to find.

startNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies the character at which to start the search. The first character in withinText is character number 1. If omitted, startNum = 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

findB(findText, withinText, startNum)

Finds the starting position of one text string within another text string. FINDB is case-sensitive. Use with double-byte character sets (DBCS).

findB(findText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, withinText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startNum?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

findText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text you want to find.

withinText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text containing the text you want to find.

startNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies the character at which to start the search.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

fisher(x)

Returns the Fisher transformation.

fisher(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want the transformation, a number between -1 and 1, excluding -1 and 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

fisherInv(y)

Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x.

fisherInv(y: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

y

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want to perform the inverse of the transformation.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

fixed(number, decimals, noCommas)

Rounds a number to the specified number of decimals and returns the result as text with or without commas.

fixed(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, decimals?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, noCommas?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number you want to round and convert to text.

decimals

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of digits to the right of the decimal point. If omitted, Decimals = 2.

noCommas

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: do not display commas in the returned text = TRUE; do display commas in the returned text = FALSE or omitted.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

floor_Math(number, significance, mode)

Rounds a number down, to the nearest integer or to the nearest multiple of significance.

floor_Math(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mode?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to round.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the multiple to which you want to round.

mode

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

When given and nonzero this function will round towards zero.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

floor_Precise(number, significance)

Rounds a number down, to the nearest integer or to the nearest multiple of significance.

floor_Precise(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numeric value you want to round.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the multiple to which you want to round.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

fv(rate, nper, pmt, pv, type)

Returns the future value of an investment based on periodic, constant payments and a constant interest rate.

fv(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payment periods in the investment.

pmt

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the payment made each period; it cannot change over the life of the investment.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value, or the lump-sum amount that a series of future payments is worth now. If omitted, Pv = 0.

type

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a value representing the timing of payment: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

fvschedule(principal, schedule)

Returns the future value of an initial principal after applying a series of compound interest rates.

fvschedule(principal: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, schedule: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

principal

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value.

schedule

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is an array of interest rates to apply.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

gamma_Dist(x, alpha, beta, cumulative)

Returns the gamma distribution.

gamma_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which you want to evaluate the distribution, a nonnegative number.

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution, a positive number.

beta

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.DIST returns the standard gamma distribution.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: return the cumulative distribution function = TRUE; return the probability mass function = FALSE or omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

gamma_Inv(probability, alpha, beta)

Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x.

gamma_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the probability associated with the gamma distribution, a number between 0 and 1, inclusive.

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution, a positive number.

beta

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution, a positive number. If beta = 1, GAMMA.INV returns the inverse of the standard gamma distribution.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

gamma(x)

Returns the Gamma function value.

gamma(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want to calculate Gamma.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

gammaLn_Precise(x)

Returns the natural logarithm of the gamma function.

gammaLn_Precise(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want to calculate GAMMALN.PRECISE, a positive number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

gammaLn(x)

Returns the natural logarithm of the gamma function.

gammaLn(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want to calculate GAMMALN, a positive number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

gauss(x)

Returns 0.5 less than the standard normal cumulative distribution.

gauss(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want the distribution.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

gcd(values)

Returns the greatest common divisor.

gcd(...values: Array<number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 values.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

geoMean(values)

Returns the geometric mean of an array or range of positive numeric data.

geoMean(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the mean.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

geStep(number, step)

Tests whether a number is greater than a threshold value.

geStep(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, step?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to test against step.

step

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the threshold value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

harMean(values)

Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals.

harMean(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the harmonic mean.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

hex2Bin(number, places)

Converts a Hexadecimal number to binary.

hex2Bin(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the hexadecimal number you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

hex2Dec(number)

Converts a hexadecimal number to decimal.

hex2Dec(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the hexadecimal number you want to convert.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

hex2Oct(number, places)

Converts a hexadecimal number to octal.

hex2Oct(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the hexadecimal number you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

hlookup(lookupValue, tableArray, rowIndexNum, rangeLookup)

Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify.

hlookup(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, tableArray: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>, rowIndexNum: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>, rangeLookup?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number | string | boolean>;

Parameters

lookupValue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to be found in the first row of the table and can be a value, a reference, or a text string.

tableArray

Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>

Is a table of text, numbers, or logical values in which data is looked up. tableArray can be a reference to a range or a range name.

rowIndexNum

Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>

Is the row number in tableArray from which the matching value should be returned. The first row of values in the table is row 1.

rangeLookup

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: to find the closest match in the top row (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE.

Returns

Excel.FunctionResult<number | string | boolean>

Remarks

[ API set: ExcelApi 1.2 ]

hour(serialNumber)

Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).

hour(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number in the date-time code used by Microsoft Excel, or text in time format, such as 16:48:00 or 4:48:00 PM.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

hyperlink(linkLocation, friendlyName)

Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet.

hyperlink(linkLocation: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, friendlyName?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number | string | boolean>;

Parameters

linkLocation

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text giving the path and file name to the document to be opened, a hard drive location, UNC address, or URL path.

friendlyName

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is text or a number that is displayed in the cell. If omitted, the cell displays the linkLocation text.

Returns

Excel.FunctionResult<number | string | boolean>

Remarks

[ API set: ExcelApi 1.2 ]

hypGeom_Dist(sampleS, numberSample, populationS, numberPop, cumulative)

Returns the hypergeometric distribution.

hypGeom_Dist(sampleS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberSample: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, populationS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberPop: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

sampleS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of successes in the sample.

numberSample

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the size of the sample.

populationS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of successes in the population.

numberPop

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the population size.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

if(logicalTest, valueIfTrue, valueIfFalse)

Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE.

if(logicalTest: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, valueIfTrue?: Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>, valueIfFalse?: Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number | string | boolean>;

Parameters

logicalTest

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any value or expression that can be evaluated to TRUE or FALSE.

valueIfTrue

Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is the value that is returned if logicalTest is TRUE. If omitted, TRUE is returned. You can nest up to seven IF functions.

valueIfFalse

Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is the value that is returned if logicalTest is FALSE. If omitted, FALSE is returned.

Returns

Excel.FunctionResult<number | string | boolean>

Remarks

[ API set: ExcelApi 1.2 ]

imAbs(inumber)

Returns the absolute value (modulus) of a complex number.

imAbs(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the absolute value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imaginary(inumber)

Returns the imaginary coefficient of a complex number.

imaginary(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the imaginary coefficient.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imArgument(inumber)

Returns the argument q, an angle expressed in radians.

imArgument(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the argument.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imConjugate(inumber)

Returns the complex conjugate of a complex number.

imConjugate(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the conjugate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imCos(inumber)

Returns the cosine of a complex number.

imCos(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the cosine.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imCosh(inumber)

Returns the hyperbolic cosine of a complex number.

imCosh(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the hyperbolic cosine.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imCot(inumber)

Returns the cotangent of a complex number.

imCot(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the cotangent.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imCsc(inumber)

Returns the cosecant of a complex number.

imCsc(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the cosecant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imCsch(inumber)

Returns the hyperbolic cosecant of a complex number.

imCsch(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the hyperbolic cosecant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imDiv(inumber1, inumber2)

Returns the quotient of two complex numbers.

imDiv(inumber1: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, inumber2: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber1

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the complex numerator or dividend.

inumber2

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the complex denominator or divisor.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imExp(inumber)

Returns the exponential of a complex number.

imExp(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the exponential.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imLn(inumber)

Returns the natural logarithm of a complex number.

imLn(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the natural logarithm.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imLog10(inumber)

Returns the base-10 logarithm of a complex number.

imLog10(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the common logarithm.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imLog2(inumber)

Returns the base-2 logarithm of a complex number.

imLog2(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the base-2 logarithm.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imPower(inumber, number)

Returns a complex number raised to an integer power.

imPower(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number you want to raise to a power.

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the power to which you want to raise the complex number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imProduct(values)

Returns the product of 1 to 255 complex numbers.

imProduct(...values: Array<Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>>

Inumber1, Inumber2,... are from 1 to 255 complex numbers to multiply.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imReal(inumber)

Returns the real coefficient of a complex number.

imReal(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the real coefficient.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imSec(inumber)

Returns the secant of a complex number.

imSec(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the secant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imSech(inumber)

Returns the hyperbolic secant of a complex number.

imSech(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the hyperbolic secant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imSin(inumber)

Returns the sine of a complex number.

imSin(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the sine.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imSinh(inumber)

Returns the hyperbolic sine of a complex number.

imSinh(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the hyperbolic sine.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imSqrt(inumber)

Returns the square root of a complex number.

imSqrt(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the square root.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imSub(inumber1, inumber2)

Returns the difference of two complex numbers.

imSub(inumber1: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, inumber2: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber1

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the complex number from which to subtract inumber2.

inumber2

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the complex number to subtract from inumber1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imSum(values)

Returns the sum of complex numbers.

imSum(...values: Array<Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are from 1 to 255 complex numbers to add.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

imTan(inumber)

Returns the tangent of a complex number.

imTan(inumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

inumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a complex number for which you want the tangent.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

int(number)

Rounds a number down to the nearest integer.

int(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the real number you want to round down to an integer.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

intRate(settlement, maturity, investment, redemption, basis)

Returns the interest rate for a fully invested security.

intRate(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, investment: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

investment

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the amount invested in the security.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the amount to be received at maturity.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ipmt(rate, per, nper, pv, fv, type)

Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.

ipmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.

per

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the period for which you want to find the interest and must be in the range 1 to Nper.

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payment periods in an investment.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value, or the lump-sum amount that a series of future payments is worth now.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, Fv = 0.

type

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value representing the timing of payment: at the end of the period = 0 or omitted, at the beginning of the period = 1.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

irr(values, guess)

Returns the internal rate of return for a series of cash flows.

irr(values: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, guess?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

values

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an array or a reference to cells that contain numbers for which you want to calculate the internal rate of return.

guess

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number that you guess is close to the result of IRR; 0.1 (10 percent) if omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

isErr(value)

Checks whether a value is an error other than #N/A, and returns TRUE or FALSE.

isErr(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

isError(value)

Checks whether a value is an error, and returns TRUE or FALSE.

isError(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

isEven(number)

Returns TRUE if the number is even.

isEven(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to test.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

isFormula(reference)

Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.

isFormula(reference: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

reference

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a reference to the cell you want to test. Reference can be a cell reference, a formula, or name that refers to a cell.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

isLogical(value)

Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.

isLogical(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

isNA(value)

Checks whether a value is #N/A, and returns TRUE or FALSE.

isNA(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

isNonText(value)

Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.

isNonText(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want tested: a cell; a formula; or a name referring to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

isNumber(value)

Checks whether a value is a number, and returns TRUE or FALSE.

isNumber(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

iso_Ceiling(number, significance)

Rounds a number up, to the nearest integer or to the nearest multiple of significance.

iso_Ceiling(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to round.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the optional multiple to which you want to round.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

isOdd(number)

Returns TRUE if the number is odd.

isOdd(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to test.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

isoWeekNum(date)

Returns the ISO week number in the year for a given date.

isoWeekNum(date: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

date

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the date-time code used by Microsoft Excel for date and time calculation.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ispmt(rate, per, nper, pv)

Returns the interest paid during a specific period of an investment.

ispmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.

per

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Period for which you want to find the interest.

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Number of payment periods in an investment.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Lump sum amount that a series of future payments is right now.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

isref(value)

Checks whether a value is a reference, and returns TRUE or FALSE.

isref(value: Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

Excel.Range | number | string | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

isText(value)

Checks whether a value is text, and returns TRUE or FALSE.

isText(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to test. Value can refer to a cell, a formula, or a name that refers to a cell, formula, or value.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

kurt(values)

Returns the kurtosis of a data set.

kurt(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the kurtosis.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

large(array, k)

Returns the k-th largest value in a data set. For example, the fifth largest number.

large(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or range of data for which you want to determine the k-th largest value.

k

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the position (from the largest) in the array or cell range of the value to return.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

lcm(values)

Returns the least common multiple.

lcm(...values: Array<number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 values for which you want the least common multiple.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

left(text, numChars)

Returns the specified number of characters from the start of a text string.

left(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numChars?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text string containing the characters you want to extract.

numChars

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies how many characters you want LEFT to extract; 1 if omitted.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

leftb(text, numBytes)

Returns the specified number of characters from the start of a text string. Use with double-byte character sets (DBCS).

leftb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numBytes?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text string containing the characters you want to extract.

numBytes

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies how many characters you want LEFT to return.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

len(text)

Returns the number of characters in a text string.

len(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text whose length you want to find. Spaces count as characters.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

lenb(text)

Returns the number of characters in a text string. Use with double-byte character sets (DBCS).

lenb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text whose length you want to find.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ln(number)

Returns the natural logarithm of a number.

ln(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the positive real number for which you want the natural logarithm.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

log(number, base)

Returns the logarithm of a number to the base you specify.

log(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, base?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the positive real number for which you want the logarithm.

base

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the base of the logarithm; 10 if omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

log10(number)

Returns the base-10 logarithm of a number.

log10(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the positive real number for which you want the base-10 logarithm.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

logNorm_Dist(x, mean, standardDev, cumulative)

Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.

logNorm_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function, a positive number.

mean

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the mean of ln(x).

standardDev

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the standard deviation of ln(x), a positive number.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

logNorm_Inv(probability, mean, standardDev)

Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.

logNorm_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability associated with the lognormal distribution, a number between 0 and 1, inclusive.

mean

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the mean of ln(x).

standardDev

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the standard deviation of ln(x), a positive number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

lookup(lookupValue, lookupVector, resultVector)

Looks up a value either from a one-row or one-column range or from an array. Provided for backward compatibility.

lookup(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, lookupVector: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, resultVector?: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number | string | boolean>;

Parameters

lookupValue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a value that LOOKUP searches for in lookupVector and can be a number, text, a logical value, or a name or reference to a value.

lookupVector

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a range that contains only one row or one column of text, numbers, or logical values, placed in ascending order.

resultVector

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a range that contains only one row or column, the same size as lookupVector.

Returns

Excel.FunctionResult<number | string | boolean>

Remarks

[ API set: ExcelApi 1.2 ]

lower(text)

Converts all letters in a text string to lowercase.

lower(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text you want to convert to lowercase. Characters in Text that are not letters are not changed.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

match(lookupValue, lookupArray, matchType)

Returns the relative position of an item in an array that matches a specified value in a specified order.

match(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, lookupArray: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, matchType?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

lookupValue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you use to find the value you want in the array, a number, text, or logical value, or a reference to one of these.

lookupArray

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a contiguous range of cells containing possible lookup values, an array of values, or a reference to an array.

matchType

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number 1, 0, or -1 indicating which value to return.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

max(values)

Returns the largest value in a set of values. Ignores logical values and text.

max(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

maxA(values)

Returns the largest value in a set of values. Does not ignore logical values and text.

maxA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the maximum.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

mduration(settlement, maturity, coupon, yld, frequency, basis)

Returns the Macauley modified duration for a security with an assumed par value of $100.

mduration(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, coupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

coupon

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual coupon rate.

yld

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual yield.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

median(values)

Returns the median, or the number in the middle of the set of given numbers.

median(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the median.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

mid(text, startNum, numChars)

Returns the characters from the middle of a text string, given a starting position and length.

mid(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numChars: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text string from which you want to extract the characters.

startNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the position of the first character you want to extract. The first character in Text is 1.

numChars

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies how many characters to return from Text.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

midb(text, startNum, numBytes)

Returns characters from the middle of a text string, given a starting position and length. Use with double-byte character sets (DBCS).

midb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numBytes: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text string containing the characters you want to extract.

startNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the position of the first character you want to extract in text.

numBytes

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies how many characters to return from text.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

min(values)

Returns the smallest number in a set of values. Ignores logical values and text.

min(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

minA(values)

Returns the smallest value in a set of values. Does not ignore logical values and text.

minA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers, empty cells, logical values, or text numbers for which you want the minimum.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

minute(serialNumber)

Returns the minute, a number from 0 to 59.

minute(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:00 or 4:48:00 PM.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

mirr(values, financeRate, reinvestRate)

Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash.

mirr(values: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, financeRate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, reinvestRate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

values

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an array or a reference to cells that contain numbers that represent a series of payments (negative) and income (positive) at regular periods.

financeRate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate you pay on the money used in the cash flows.

reinvestRate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate you receive on the cash flows as you reinvest them.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

mod(number, divisor)

Returns the remainder after a number is divided by a divisor.

mod(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, divisor: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number for which you want to find the remainder after the division is performed.

divisor

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number by which you want to divide Number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

month(serialNumber)

Returns the month, a number from 1 (January) to 12 (December).

month(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number in the date-time code used by Microsoft Excel.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

mround(number, multiple)

Returns a number rounded to the desired multiple.

mround(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, multiple: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to round.

multiple

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the multiple to which you want to round number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

multiNomial(values)

Returns the multinomial of a set of numbers.

multiNomial(...values: Array<number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 values for which you want the multinomial.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

n(value)

Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero).

n(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want converted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

na()

Returns the error value #N/A (value not available).

na(): FunctionResult<number | string>;

Returns

Excel.FunctionResult<number | string>

Remarks

[ API set: ExcelApi 1.2 ]

negBinom_Dist(numberF, numberS, probabilityS, cumulative)

Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success.

negBinom_Dist(numberF: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, probabilityS: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

numberF

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of failures.

numberS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the threshold number of successes.

probabilityS

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the probability of a success; a number between 0 and 1.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

networkDays_Intl(startDate, endDate, weekend, holidays)

Returns the number of whole workdays between two dates with custom weekend parameters.

networkDays_Intl(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, endDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, weekend?: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the start date.

endDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the end date.

weekend

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number or string specifying when weekends occur.

holidays

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

networkDays(startDate, endDate, holidays)

Returns the number of whole workdays between two dates.

networkDays(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, endDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the start date.

endDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the end date.

holidays

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional set of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

nominal(effectRate, npery)

Returns the annual nominal interest rate.

nominal(effectRate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, npery: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

effectRate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the effective interest rate.

npery

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of compounding periods per year.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

norm_Dist(x, mean, standardDev, cumulative)

Returns the normal distribution for the specified mean and standard deviation.

norm_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want the distribution.

mean

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the arithmetic mean of the distribution.

standardDev

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the standard deviation of the distribution, a positive number.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

norm_Inv(probability, mean, standardDev)

Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.

norm_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive.

mean

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the arithmetic mean of the distribution.

standardDev

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the standard deviation of the distribution, a positive number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

norm_S_Dist(z, cumulative)

Returns the standard normal distribution (has a mean of zero and a standard deviation of one).

norm_S_Dist(z: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

z

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want the distribution.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value for the function to return: the cumulative distribution function = TRUE; the probability density function = FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

norm_S_Inv(probability)

Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one).

norm_S_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a probability corresponding to the normal distribution, a number between 0 and 1 inclusive.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

not(logical)

Changes FALSE to TRUE, or TRUE to FALSE.

not(logical: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<boolean>;

Parameters

logical

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a value or expression that can be evaluated to TRUE or FALSE.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

now()

Returns the current date and time formatted as a date and time.

now(): FunctionResult<number>;

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

nper(rate, pmt, pv, fv, type)

Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.

nper(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.

pmt

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the payment made each period; it cannot change over the life of the investment.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value, or the lump-sum amount that a series of future payments is worth now.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, zero is used.

type

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

npv(rate, values)

Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).

npv(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the rate of discount over the length of one period.

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 254 payments and income, equally spaced in time and occurring at the end of each period.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

numberValue(text, decimalSeparator, groupSeparator)

Converts text to number in a locale-independent manner.

numberValue(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, decimalSeparator?: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, groupSeparator?: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the string representing the number you want to convert.

decimalSeparator

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the character used as the decimal separator in the string.

groupSeparator

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the character used as the group separator in the string.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

oct2Bin(number, places)

Converts an octal number to binary.

oct2Bin(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the octal number you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

oct2Dec(number)

Converts an octal number to decimal.

oct2Dec(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the octal number you want to convert.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

oct2Hex(number, places)

Converts an octal number to hexadecimal.

oct2Hex(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, places?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the octal number you want to convert.

places

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

odd(number)

Rounds a positive number up and negative number down to the nearest odd integer.

odd(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to round.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

oddFPrice(settlement, maturity, issue, firstCoupon, rate, yld, redemption, frequency, basis)

Returns the price per $100 face value of a security with an odd first period.

oddFPrice(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, firstCoupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

issue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's issue date, expressed as a serial date number.

firstCoupon

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's first coupon date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's interest rate.

yld

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual yield.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

oddFYield(settlement, maturity, issue, firstCoupon, rate, pr, redemption, frequency, basis)

Returns the yield of a security with an odd first period.

oddFYield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, firstCoupon: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

issue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's issue date, expressed as a serial date number.

firstCoupon

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's first coupon date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's interest rate.

pr

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's price.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

oddLPrice(settlement, maturity, lastInterest, rate, yld, redemption, frequency, basis)

Returns the price per $100 face value of a security with an odd last period.

oddLPrice(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, lastInterest: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

lastInterest

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's last coupon date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's interest rate.

yld

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual yield.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

oddLYield(settlement, maturity, lastInterest, rate, pr, redemption, frequency, basis)

Returns the yield of a security with an odd last period.

oddLYield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, lastInterest: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

lastInterest

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's last coupon date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's interest rate.

pr

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's price.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

or(values)

Checks whether any of the arguments are TRUE, and returns TRUE or FALSE. Returns FALSE only if all arguments are FALSE.

or(...values: Array<boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<boolean>;

Parameters

values

Array<boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 conditions that you want to test that can be either TRUE or FALSE.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

pduration(rate, pv, fv)

Returns the number of periods required by an investment to reach a specified value.

pduration(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate per period.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value of the investment.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the desired future value of the investment.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

percentile_Exc(array, k)

Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.

percentile_Exc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or range of data that defines relative standing.

k

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the percentile value that is between 0 through 1, inclusive.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

percentile_Inc(array, k)

Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive.

percentile_Inc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or range of data that defines relative standing.

k

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the percentile value that is between 0 through 1, inclusive.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

percentRank_Exc(array, x, significance)

Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.

percentRank_Exc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or range of data with numeric values that defines relative standing.

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want to know the rank.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%).

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

percentRank_Inc(array, x, significance)

Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set.

percentRank_Inc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, significance?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or range of data with numeric values that defines relative standing.

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value for which you want to know the rank.

significance

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional value that identifies the number of significant digits for the returned percentage, three digits if omitted (0.xxx%).

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

permut(number, numberChosen)

Returns the number of permutations for a given number of objects that can be selected from the total objects.

permut(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of objects.

numberChosen

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of objects in each permutation.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

permutationa(number, numberChosen)

Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.

permutationa(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberChosen: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of objects.

numberChosen

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of objects in each permutation.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

phi(x)

Returns the value of the density function for a standard normal distribution.

phi(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number for which you want the density of the standard normal distribution.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

pi()

Returns the value of Pi, 3.14159265358979, accurate to 15 digits.

pi(): FunctionResult<number>;

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

pmt(rate, nper, pv, fv, type)

Calculates the payment for a loan based on constant payments and a constant interest rate.

pmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate per period for the loan. For example, use 6%/4 for quarterly payments at 6% APR.

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payments for the loan.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value: the total amount that a series of future payments is worth now.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the future value, or a cash balance you want to attain after the last payment is made, 0 (zero) if omitted.

type

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

poisson_Dist(x, mean, cumulative)

Returns the Poisson distribution.

poisson_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of events.

mean

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the expected numeric value, a positive number.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative Poisson probability, use TRUE; for the Poisson probability mass function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

power(number, power)

Returns the result of a number raised to a power.

power(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, power: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the base number, any real number.

power

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the exponent, to which the base number is raised.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

ppmt(rate, per, nper, pv, fv, type)

Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.

ppmt(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.

per

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies the period and must be in the range 1 to nper.

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payment periods in an investment.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value: the total amount that a series of future payments is worth now.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the future value, or cash balance you want to attain after the last payment is made.

type

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

price(settlement, maturity, rate, yld, redemption, frequency, basis)

Returns the price per $100 face value of a security that pays periodic interest.

price(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual coupon rate.

yld

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual yield.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

priceDisc(settlement, maturity, discount, redemption, basis)

Returns the price per $100 face value of a discounted security.

priceDisc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

discount

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's discount rate.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

priceMat(settlement, maturity, issue, rate, yld, basis)

Returns the price per $100 face value of a security that pays interest at maturity.

priceMat(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, yld: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

issue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's issue date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's interest rate at date of issue.

yld

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual yield.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

product(values)

Multiplies all the numbers given as arguments.

product(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers, logical values, or text representations of numbers that you want to multiply.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

proper(text)

Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase.

proper(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is text enclosed in quotation marks, a formula that returns text, or a reference to a cell containing text to partially capitalize.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

pv(rate, nper, pmt, fv, type)

Returns the present value of an investment: the total amount that a series of future payments is worth now.

pv(rate: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payment periods in an investment.

pmt

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the payment made each period and cannot change over the life of the investment.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the future value, or a cash balance you want to attain after the last payment is made.

type

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

quartile_Exc(array, quart)

Returns the quartile of a data set, based on percentile values from 0..1, exclusive.

quartile_Exc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, quart: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or cell range of numeric values for which you want the quartile value.

quart

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

quartile_Inc(array, quart)

Returns the quartile of a data set, based on percentile values from 0..1, inclusive.

quartile_Inc(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, quart: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or cell range of numeric values for which you want the quartile value.

quart

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number: minimum value = 0; 1st quartile = 1; median value = 2; 3rd quartile = 3; maximum value = 4.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

quotient(numerator, denominator)

Returns the integer portion of a division.

quotient(numerator: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, denominator: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

numerator

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the dividend.

denominator

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the divisor.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

radians(angle)

Converts degrees to radians.

radians(angle: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

angle

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an angle in degrees that you want to convert.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

rand()

Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation).

rand(): FunctionResult<number>;

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

randBetween(bottom, top)

Returns a random number between the numbers you specify.

randBetween(bottom: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, top: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

bottom

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the smallest integer RANDBETWEEN will return.

top

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the largest integer RANDBETWEEN will return.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

rank_Avg(number, ref, order)

Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned.

rank_Avg(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ref: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, order?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number for which you want to find the rank.

ref

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored.

order

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

rank_Eq(number, ref, order)

Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned.

rank_Eq(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ref: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, order?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number for which you want to find the rank.

ref

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an array of, or a reference to, a list of numbers. Nonnumeric values are ignored.

order

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number: rank in the list sorted descending = 0 or omitted; rank in the list sorted ascending = any nonzero value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

rate(nper, pmt, pv, fv, type, guess)

Returns the interest rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR.

rate(nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pmt: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, type?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, guess?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the total number of payment periods for the loan or investment.

pmt

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the payment made each period and cannot change over the life of the loan or investment.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value: the total amount that a series of future payments is worth now.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, uses Fv = 0.

type

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

guess

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is your guess for what the rate will be; if omitted, Guess = 0.1 (10 percent).

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

received(settlement, maturity, investment, discount, basis)

Returns the amount received at maturity for a fully invested security.

received(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, investment: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

investment

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the amount invested in the security.

discount

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's discount rate.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

replace(oldText, startNum, numChars, newText)

Replaces part of a text string with a different text string.

replace(oldText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numChars: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, newText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

oldText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is text in which you want to replace some characters.

startNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the position of the character in oldText that you want to replace with newText.

numChars

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters in oldText that you want to replace.

newText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text that will replace characters in oldText.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

replaceB(oldText, startNum, numBytes, newText)

Replaces part of a text string with a different text string. Use with double-byte character sets (DBCS).

replaceB(oldText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numBytes: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, newText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

oldText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is text in which you want to replace some characters.

startNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the position of the character in oldText that you want to replace with newText.

numBytes

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of characters in oldText that you want to replace with newText.

newText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text that will replace characters in oldText.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

rept(text, numberTimes)

Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.

rept(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numberTimes: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text you want to repeat.

numberTimes

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a positive number specifying the number of times to repeat text.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

right(text, numChars)

Returns the specified number of characters from the end of a text string.

right(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numChars?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text string that contains the characters you want to extract.

numChars

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies how many characters you want to extract, 1 if omitted.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

rightb(text, numBytes)

Returns the specified number of characters from the end of a text string. Use with double-byte character sets (DBCS).

rightb(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numBytes?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text string containing the characters you want to extract.

numBytes

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies how many characters you want to extract.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

roman(number, form)

Converts an Arabic numeral to Roman, as text.

roman(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, form?: boolean | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Arabic numeral you want to convert.

form

boolean | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number specifying the type of Roman numeral you want.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

round(number, numDigits)

Rounds a number to a specified number of digits.

round(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numDigits: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number you want to round.

numDigits

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero to the nearest integer.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

roundDown(number, numDigits)

Rounds a number down, toward zero.

roundDown(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numDigits: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number that you want rounded down.

numDigits

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

roundUp(number, numDigits)

Rounds a number up, away from zero.

roundUp(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numDigits: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number that you want rounded up.

numDigits

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of digits to which you want to round. Negative rounds to the left of the decimal point; zero or omitted, to the nearest integer.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

rows(array)

Returns the number of rows in a reference or array.

rows(array: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an array, an array formula, or a reference to a range of cells for which you want the number of rows.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

rri(nper, pv, fv)

Returns an equivalent interest rate for the growth of an investment.

rri(nper: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, fv: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

nper

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of periods for the investment.

pv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the present value of the investment.

fv

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the future value of the investment.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sec(number)

Returns the secant of an angle.

sec(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the secant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sech(number)

Returns the hyperbolic secant of an angle.

sech(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the hyperbolic secant.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

second(serialNumber)

Returns the second, a number from 0 to 59.

second(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number in the date-time code used by Microsoft Excel or text in time format, such as 16:48:23 or 4:48:47 PM.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

seriesSum(x, n, m, coefficients)

Returns the sum of a power series based on the formula.

seriesSum(x: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, n: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, m: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, coefficients: Excel.Range | string | number | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the input value to the power series.

n

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the initial power to which you want to raise x.

m

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the step by which to increase n for each term in the series.

coefficients

Excel.Range | string | number | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is a set of coefficients by which each successive power of x is multiplied.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sheet(value)

Returns the sheet number of the referenced sheet.

sheet(value?: Excel.Range | string | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

value

Excel.Range | string | Excel.RangeReference | Excel.FunctionResult<any>

Is the name of a sheet or a reference that you want the sheet number of. If omitted the number of the sheet containing the function is returned.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sheets(reference)

Returns the number of sheets in a reference.

sheets(reference?: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

reference

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a reference for which you want to know the number of sheets it contains. If omitted the number of sheets in the workbook containing the function is returned.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sign(number)

Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative.

sign(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sin(number)

Returns the sine of an angle.

sin(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the sine. Degrees * PI()/180 = radians.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sinh(number)

Returns the hyperbolic sine of a number.

sinh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

skew_p(values)

Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean.

skew_p(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 254 numbers or names, arrays, or references that contain numbers for which you want the population skewness.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

skew(values)

Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean.

skew(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers or names, arrays, or references that contain numbers for which you want the skewness.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sln(cost, salvage, life)

Returns the straight-line depreciation of an asset for one period.

sln(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

cost

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the initial cost of the asset.

salvage

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the salvage value at the end of the life of the asset.

life

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

small(array, k)

Returns the k-th smallest value in a data set. For example, the fifth smallest number.

small(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, k: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an array or range of numerical data for which you want to determine the k-th smallest value.

k

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the position (from the smallest) in the array or range of the value to return.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sqrt(number)

Returns the square root of a number.

sqrt(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number for which you want the square root.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sqrtPi(number)

Returns the square root of (number * Pi).

sqrtPi(number: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number by which p is multiplied.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

standardize(x, mean, standardDev)

Returns a normalized value from a distribution characterized by a mean and standard deviation.

standardize(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, mean: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, standardDev: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value you want to normalize.

mean

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the arithmetic mean of the distribution.

standardDev

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the standard deviation of the distribution, a positive number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

stDev_P(values)

Calculates standard deviation based on the entire population given as arguments (ignores logical values and text).

stDev_P(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers corresponding to a population and can be numbers or references that contain numbers.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

stDev_S(values)

Estimates standard deviation based on a sample (ignores logical values and text in the sample).

stDev_S(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers corresponding to a sample of a population and can be numbers or references that contain numbers.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

stDevA(values)

Estimates standard deviation based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.

stDevA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 values corresponding to a sample of a population and can be values or names or references to values.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

stDevPA(values)

Calculates standard deviation based on an entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.

stDevPA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 values corresponding to a population and can be values, names, arrays, or references that contain values.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

substitute(text, oldText, newText, instanceNum)

Replaces existing text with new text in a text string.

substitute(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, oldText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, newText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, instanceNum?: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text or the reference to a cell containing text in which you want to substitute characters.

oldText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the existing text you want to replace. If the case of oldText does not match the case of text, SUBSTITUTE will not replace the text.

newText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text you want to replace oldText with.

instanceNum

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Specifies which occurrence of oldText you want to replace. If omitted, every instance of oldText is replaced.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

subtotal(functionNum, values)

Returns a subtotal in a list or database.

subtotal(functionNum: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ...values: Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

functionNum

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number 1 to 11 that specifies the summary function for the subtotal.

values

Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 254 ranges or references for which you want the subtotal.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sum(values)

Adds all the numbers in a range of cells.

sum(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers to sum. Logical values and text are ignored in cells, included if typed as arguments.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml

await Excel.run(async (context) => {
  // This function uses VLOOKUP to find data in the "Wrench" row 
  // on the worksheet, and then it uses SUM to combine the values.
  let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4");

  // Get the values in the second, third, and fourth columns in the "Wrench" row,
  // and combine those values with SUM. 
  let sumOfTwoLookups = context.workbook.functions.sum(
    context.workbook.functions.vlookup("Wrench", range, 2, false),
    context.workbook.functions.vlookup("Wrench", range, 3, false),
    context.workbook.functions.vlookup("Wrench", range, 4, false)
  );
  sumOfTwoLookups.load("value");

  await context.sync();
  console.log(" Number of wrenches sold in November, December, and January = " + sumOfTwoLookups.value);
});

sumIf(range, criteria, sumRange)

Adds the cells specified by a given condition or criteria.

sumIf(range: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, criteria: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, sumRange?: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

range

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range of cells you want evaluated.

criteria

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.

sumRange

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Are the actual cells to sum. If omitted, the cells in range are used.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sumIfs(sumRange, values)

Adds the cells specified by a given set of conditions or criteria.

sumIfs(sumRange: Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, ...values: Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any> | number | string | boolean>): FunctionResult<number>;

Parameters

sumRange

Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Are the actual cells to sum.

values

Array<Excel.Range | Excel.RangeReference | Excel.FunctionResult<any> | number | string | boolean>

List of parameters, where the first element of each pair is the Is the range of cells you want evaluated for the particular condition , and the second element is is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

sumSq(values)

Returns the sum of the squares of the arguments. The arguments can be numbers, arrays, names, or references to cells that contain numbers.

sumSq(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numbers, arrays, names, or references to arrays for which you want the sum of the squares.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

syd(cost, salvage, life, per)

Returns the sum-of-years' digits depreciation of an asset for a specified period.

syd(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, per: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

cost

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the initial cost of the asset.

salvage

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the salvage value at the end of the life of the asset.

life

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).

per

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the period and must use the same units as Life.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

t_Dist_2T(x, degFreedom)

Returns the two-tailed Student's t-distribution.

t_Dist_2T(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numeric value at which to evaluate the distribution.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an integer indicating the number of degrees of freedom that characterize the distribution.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

t_Dist_RT(x, degFreedom)

Returns the right-tailed Student's t-distribution.

t_Dist_RT(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numeric value at which to evaluate the distribution.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an integer indicating the number of degrees of freedom that characterize the distribution.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

t_Dist(x, degFreedom, cumulative)

Returns the left-tailed Student's t-distribution.

t_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the numeric value at which to evaluate the distribution.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is an integer indicating the number of degrees of freedom that characterize the distribution.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability density function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

t_Inv_2T(probability, degFreedom)

Returns the two-tailed inverse of the Student's t-distribution.

t_Inv_2T(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a positive integer indicating the number of degrees of freedom to characterize the distribution.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

t_Inv(probability, degFreedom)

Returns the left-tailed inverse of the Student's t-distribution.

t_Inv(probability: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, degFreedom: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

probability

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the probability associated with the two-tailed Student's t-distribution, a number between 0 and 1 inclusive.

degFreedom

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a positive integer indicating the number of degrees of freedom to characterize the distribution.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

t(value)

Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not.

t(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to test.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

tan(number)

Returns the tangent of an angle.

tan(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the angle in radians for which you want the tangent. Degrees * PI()/180 = radians.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

tanh(number)

Returns the hyperbolic tangent of a number.

tanh(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is any real number.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

tbillEq(settlement, maturity, discount)

Returns the bond-equivalent yield for a treasury bill.

tbillEq(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's maturity date, expressed as a serial date number.

discount

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's discount rate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

tbillPrice(settlement, maturity, discount)

Returns the price per $100 face value for a treasury bill.

tbillPrice(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, discount: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's maturity date, expressed as a serial date number.

discount

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's discount rate.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

tbillYield(settlement, maturity, pr)

Returns the yield for a treasury bill.

tbillYield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury bill's maturity date, expressed as a serial date number.

pr

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Treasury Bill's price per $100 face value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

text(value, formatText)

Converts a value to text in a specific number format.

text(value: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, formatText: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

value

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number, a formula that evaluates to a numeric value, or a reference to a cell containing a numeric value.

formatText

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number format in text form from the Category box on the Number tab in the Format Cells dialog box.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

time(hour, minute, second)

Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format.

time(hour: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, minute: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, second: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

hour

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number from 0 to 23 representing the hour.

minute

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number from 0 to 59 representing the minute.

second

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number from 0 to 59 representing the second.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

timevalue(timeText)

Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM). Format the number with a time format after entering the formula.

timevalue(timeText: string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

timeText

string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a text string that gives a time in any one of the Microsoft Excel time formats (date information in the string is ignored).

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

today()

Returns the current date formatted as a date.

today(): FunctionResult<number>;

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.Functions object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.FunctionsData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): {
            [key: string]: string;
        };

Returns

{ [key: string]: string; }

trim(text)

Removes all spaces from a text string except for single spaces between words.

trim(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text from which you want spaces removed.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

trimMean(array, percent)

Returns the mean of the interior portion of a set of data values.

trimMean(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, percent: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the range or array of values to trim and average.

percent

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the fractional number of data points to exclude from the top and bottom of the data set.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

true()

Returns the logical value TRUE.

true(): FunctionResult<boolean>;

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

trunc(number, numDigits)

Truncates a number to an integer by removing the decimal, or fractional, part of the number.

trunc(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, numDigits?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number you want to truncate.

numDigits

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number specifying the precision of the truncation, 0 (zero) if omitted.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

type(value)

Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128.

type(value: boolean | string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

value

boolean | string | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Can be any value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

unichar(number)

Returns the Unicode character referenced by the given numeric value.

unichar(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the Unicode number representing a character.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

unicode(text)

Returns the number (code point) corresponding to the first character of the text.

unicode(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the character that you want the Unicode value of.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

upper(text)

Converts a text string to all uppercase letters.

upper(text: string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

text

string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text you want converted to uppercase, a reference or a text string.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

usdollar(number, decimals)

Converts a number to text, using currency format.

usdollar(number: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, decimals?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<string>;

Parameters

number

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number, a reference to a cell containing a number, or a formula that evaluates to a number.

decimals

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of digits to the right of the decimal point.

Returns

Excel.FunctionResult<string>

Remarks

[ API set: ExcelApi 1.2 ]

value(text)

Converts a text string that represents a number to a number.

value(text: string | boolean | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

text

string | boolean | number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the text enclosed in quotation marks or a reference to a cell containing the text you want to convert.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

var_P(values)

Calculates variance based on the entire population (ignores logical values and text in the population).

var_P(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a population.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

var_S(values)

Estimates variance based on a sample (ignores logical values and text in the sample).

var_S(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 numeric arguments corresponding to a sample of a population.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

varA(values)

Estimates variance based on a sample, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.

varA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 value arguments corresponding to a sample of a population.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

varPA(values)

Calculates variance based on the entire population, including logical values and text. Text and the logical value FALSE have the value 0; the logical value TRUE has the value 1.

varPA(...values: Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<number>;

Parameters

values

Array<number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 255 value arguments corresponding to a population.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

vdb(cost, salvage, life, startPeriod, endPeriod, factor, noSwitch)

Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify.

vdb(cost: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, salvage: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, life: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, startPeriod: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, endPeriod: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, factor?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, noSwitch?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

cost

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the initial cost of the asset.

salvage

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the salvage value at the end of the life of the asset.

life

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of periods over which the asset is being depreciated (sometimes called the useful life of the asset).

startPeriod

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the starting period for which you want to calculate the depreciation, in the same units as Life.

endPeriod

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the ending period for which you want to calculate the depreciation, in the same units as Life.

factor

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the rate at which the balance declines, 2 (double-declining balance) if omitted.

noSwitch

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Switch to straight-line depreciation when depreciation is greater than the declining balance = FALSE or omitted; do not switch = TRUE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

vlookup(lookupValue, tableArray, colIndexNum, rangeLookup)

Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify. By default, the table must be sorted in an ascending order.

vlookup(lookupValue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, tableArray: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>, colIndexNum: Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>, rangeLookup?: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number | string | boolean>;

Parameters

lookupValue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to be found in the first column of the table, and can be a value, a reference, or a text string.

tableArray

Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>

Is a table of text, numbers, or logical values, in which data is retrieved. tableArray can be a reference to a range or a range name.

colIndexNum

Excel.Range | number | Excel.RangeReference | Excel.FunctionResult<any>

Is the column number in tableArray from which the matching value should be returned. The first column of values in the table is column 1.

rangeLookup

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: to find the closest match in the first column (sorted in ascending order) = TRUE or omitted; find an exact match = FALSE.

Returns

Excel.FunctionResult<number | string | boolean>

Remarks

[ API set: ExcelApi 1.2 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml

await Excel.run(async (context) => {
  // This function uses VLOOKUP to find data in the "Wrench" row on the worksheet. 
  let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4");

  // Get the value in the second column in the "Wrench" row.
  let unitSoldInNov = context.workbook.functions.vlookup("Wrench", range, 2, false);
  unitSoldInNov.load("value");

  await context.sync();
  console.log(" Number of wrenches sold in November = " + unitSoldInNov.value);
});

weekday(serialNumber, returnType)

Returns a number from 1 to 7 identifying the day of the week of a date.

weekday(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, returnType?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number that represents a date.

returnType

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number: for Sunday=1 through Saturday=7, use 1; for Monday=1 through Sunday=7, use 2; for Monday=0 through Sunday=6, use 3.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

weekNum(serialNumber, returnType)

Returns the week number in the year.

weekNum(serialNumber: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, returnType?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the date-time code used by Microsoft Excel for date and time calculation.

returnType

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number (1 or 2) that determines the type of the return value.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

weibull_Dist(x, alpha, beta, cumulative)

Returns the Weibull distribution.

weibull_Dist(x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, alpha: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, beta: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, cumulative: boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value at which to evaluate the function, a nonnegative number.

alpha

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution, a positive number.

beta

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a parameter to the distribution, a positive number.

cumulative

boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a logical value: for the cumulative distribution function, use TRUE; for the probability mass function, use FALSE.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

workDay_Intl(startDate, days, weekend, holidays)

Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.

workDay_Intl(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, days: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, weekend?: number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the start date.

days

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of nonweekend and non-holiday days before or after startDate.

weekend

number | string | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number or string specifying when weekends occur.

holidays

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

workDay(startDate, days, holidays)

Returns the serial number of the date before or after a specified number of workdays.

workDay(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, days: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, holidays?: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the start date.

days

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of nonweekend and non-holiday days before or after startDate.

holidays

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is an optional array of one or more serial date numbers to exclude from the working calendar, such as state and federal holidays and floating holidays.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

xirr(values, dates, guess)

Returns the internal rate of return for a schedule of cash flows.

xirr(values: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>, dates: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>, guess?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

values

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is a series of cash flows that correspond to a schedule of payments in dates.

dates

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is a schedule of payment dates that corresponds to the cash flow payments.

guess

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number that you guess is close to the result of XIRR.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

xnpv(rate, values, dates)

Returns the net present value for a schedule of cash flows.

xnpv(rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, values: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>, dates: number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the discount rate to apply to the cash flows.

values

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is a series of cash flows that correspond to a schedule of payments in dates.

dates

number | string | Excel.Range | boolean | Excel.RangeReference | Excel.FunctionResult<any>

Is a schedule of payment dates that corresponds to the cash flow payments.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

xor(values)

Returns a logical 'Exclusive Or' of all arguments.

xor(...values: Array<boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>): FunctionResult<boolean>;

Parameters

values

Array<boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>>

List of parameters, whose elements are 1 to 254 conditions you want to test that can be either TRUE or FALSE and can be logical values, arrays, or references.

Returns

Excel.FunctionResult<boolean>

Remarks

[ API set: ExcelApi 1.2 ]

year(serialNumber)

Returns the year of a date, an integer in the range 1900 - 9999.

year(serialNumber: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

serialNumber

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a number in the date-time code used by Microsoft Excel.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

yearFrac(startDate, endDate, basis)

Returns the year fraction representing the number of whole days between start_date and end_date.

yearFrac(startDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, endDate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

startDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the start date.

endDate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is a serial date number that represents the end date.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

yield(settlement, maturity, rate, pr, redemption, frequency, basis)

Returns the yield on a security that pays periodic interest.

yield(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, frequency: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's annual coupon rate.

pr

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's price per $100 face value.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

frequency

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the number of coupon payments per year.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

yieldDisc(settlement, maturity, pr, redemption, basis)

Returns the annual yield for a discounted security. For example, a treasury bill.

yieldDisc(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, redemption: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

pr

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's price per $100 face value.

redemption

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's redemption value per $100 face value.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

yieldMat(settlement, maturity, issue, rate, pr, basis)

Returns the annual yield of a security that pays interest at maturity.

yieldMat(settlement: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, maturity: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, issue: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, rate: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, pr: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, basis?: number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

settlement

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's settlement date, expressed as a serial date number.

maturity

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's maturity date, expressed as a serial date number.

issue

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's issue date, expressed as a serial date number.

rate

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's interest rate at date of issue.

pr

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the security's price per $100 face value.

basis

number | string | boolean | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the type of day count basis to use.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]

z_Test(array, x, sigma)

Returns the one-tailed P-value of a z-test.

z_Test(array: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, x: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>, sigma?: number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>): FunctionResult<number>;

Parameters

array

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the array or range of data against which to test X.

x

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the value to test.

sigma

number | Excel.Range | Excel.RangeReference | Excel.FunctionResult<any>

Is the population (known) standard deviation. If omitted, the sample standard deviation is used.

Returns

Excel.FunctionResult<number>

Remarks

[ API set: ExcelApi 1.2 ]