getCustomFunction Method

Gets the specified user-defined custom function.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GcSpread.Sheets.Sheet(name);
var value; // Type: Object
value = instance.getCustomFunction(name);

function getCustomFunction( 
   name : string
) : Object;

Parameters

name: The name of the user-defined custom function.

Return Value

Returns the function with the specified name.

Example

This example returns the specified custom function.

Javascript

// Type =factorial(5) in a cell to see the result
function FactorialFunction() {
this.name = "FACTORIAL";
this.maxArgs = 1;
this.minArgs = 1;
}
FactorialFunction.prototype = new GcSpread.Sheets.Calc.Functions.Function();
FactorialFunction.prototype.evaluate = function (args) {
var result = 1;
if (args.length === 1 && !isNaN(parseInt(args[0]))) {
for (var i = 1; i < args[0]; i++) {
result = i * result;
}
return result;
}
return "#VALUE!";
}
var factorial = new FactorialFunction();
activeSheet.addCustomFunction(factorial);
activeSheet.getCell(0,0).formula("factorial(5)");
var name = activeSheet.getCustomFunction("factorial");
alert(name);

Reference

Sheet type
Creating Custom Formulas