FLOOR
Rounds a number down to the nearest multiple of significance.
Syntax
expression.FLOOR(arg1, arg2);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number | The numeric value to round down. | |
| arg2 | Required | ApiRange | ApiName | number | The multiple of significance to round down to. The number to round down and the multiple of significance must have the same sign. |
Returns
number
Example
This example shows how to round a number down to the nearest multiple of significance.
- Code
- Result
// How to round a number down to the nearest multiple of significance.
// Use function to round down.
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.FLOOR(5.786, 0.7));