SpreadJS製品ヘルプ
getCustomFunction メソッド
GC.Spread.Sheets 名前空間 > Workbook タイプ : getCustomFunction メソッド
カスタム関数名。
カスタム関数を取得します。
シンタックス
var instance = new GC.Spread.Sheets.Workbook(host,
                                            options,
                                            options.sheetCount,
                                            options.font,
                                            options.allowUserDragMerge,
                                            options.allowUserDragDrop,
                                            options.allowUserDragFill,
                                            options.allowUserZoom,
                                            options.allowUserResize,
                                            options.allowUndo,
                                            options.allowSheetReorder,
                                            options.allowContextMenu,
                                            options.allowUserDeselect,
                                            options.defaultDragFillType,
                                            options.showDragFillSmartTag,
                                            options.showHorizontalScrollbar,
                                            options.showVerticalScrollbar,
                                            options.scrollbarShowMax,
                                            options.scrollbarMaxAlign,
                                            options.tabStripVisible,
                                            options.tabStripRatio,
                                            options.tabEditable,
                                            options.newTabVisible,
                                            options.tabNavigationVisible,
                                            options.cutCopyIndicatorVisible,
                                            options.cutCopyIndicatorBorderColor,
                                            options.backColor,
                                            options.backgroundImage,
                                            options.backgroundImageLayout,
                                            options.grayAreaBackColor,
                                            options.showResizeTip,
                                            options.showDragDropTip,
                                            options.showDragFillTip,
                                            options.showScrollTip,
                                            options.scrollIgnoreHidden,
                                            options.highlightInvalidData,
                                            options.useTouchLayout,
                                            options.hideSelection,
                                            options.resizeZeroIndicator,
                                            options.allowUserEditFormula,
                                            options.enableFormulaTextbox,
                                            options.autoFitType,
                                            options.referenceStyle,
                                            options.calcOnDemand,
                                            options.allowCopyPasteExcelStyle,
                                            options.allowExtendPasteRange,
                                            options.copyPasteHeaderOptions,
                                            options.scrollByPixel,
                                            options.scrollPixel,
                                            options.allowAutoCreateHyperlink,
                                            options.columnResizeMode,
                                            options.rowResizeMode,
                                            options.customList,
                                            options.scrollbarAppearance);
var value; // Type: Function
value = instance.getCustomFunction(name);
function getCustomFunction( 
   name : string
) : Function;

パラメータ

name
カスタム関数名。

戻り値の型

カスタム関数。
使用例
次のサンプルコードは、getCustomFunctionメソッドを使用します。
function FactorialFunction() {
    this.name = "FACTORIAL";
    this.maxArgs = 1;
    this.minArgs = 1;
}
FactorialFunction.prototype = new GC.Spread.CalcEngine.Functions.Function();
FactorialFunction.prototype.evaluate = function () {
    var result = 1, args = arguments;
    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();
spread.addCustomFunction(factorial);
activeSheet.getCell(0,0).formula("factorial(5)");
var name = spread.getCustomFunction("factorial");
alert(name);
function FactorialFunction() {
    this.name = "FACTORIAL";
    this.maxArgs = 1;
    this.minArgs = 1;
}
FactorialFunction.prototype = new GC.Spread.CalcEngine.Functions.Function();
FactorialFunction.prototype.evaluate = function () {
    var result = 1, args = arguments;
    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();
spread.addCustomFunction(factorial);
activeSheet.getCell(0,0).formula("factorial(5)");
var name = spread.getCustomFunction("factorial");
alert(name);
関連トピック

参照

Workbook タイプ