POISSON_DIST

Returns the Poisson distribution.

Syntax

expression.POISSON_DIST(arg1, arg2, arg3);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

Name	Required/Optional	Data type	Default	Description
arg1	Required	ApiRange | ApiName | number		The number of events.
arg2	Required	ApiRange | ApiName | number		The expected numeric value, a positive number.
arg3	Required	ApiRange | ApiName | boolean		A logical value (true or false) that determines the function form. If it is true, the function returns the cumulative Poisson probability. If it is false, the function returns the Poisson probability mass function.

Returns

number

Example

This example shows how to calculate the Poisson distribution.

• Code
• Result

// How to return the Poisson distribution.

// Use a function to calculate the Poisson distribution.

const worksheet = Api.GetActiveSheet();

//method params
let x = 9;
let mean = 12;
let cumulative = false;

let func = Api.GetWorksheetFunction();
let ans = func.POISSON_DIST(x, mean, cumulative);

worksheet.GetRange("C1").SetValue(ans);