v8
Forguncy Class ForguncyCommandHelper Forguncy API クラス

ForguncyCommandHelper クラス

コマンドに関係するヘルパーメソッドを提供するクラス。

階層

  • ForguncyCommandHelper

メソッド

executeCellCommand

  • executeCellCommand(cellName: string, completedCallback?: Function): void
  • 指定したセルのコマンドを実行します。

    使用例
    Forguncy.CommandHelper.executeCellCommand("cellName", function(){
        console.log("Exectue Completed");
    });

    引数

    • cellName: string

      セル名。

    • オプション completedCallback: Function

      コマンドが実行された時のコールバック関数を指定します。

    戻り値 void

getAllVariableValues

  • getAllVariableValues(): Object
  • コマンド実行時にすべての変数名とその値を取得します。

    使用例
    var variables = Forguncy.CommandHelper.getAllVariableValues();
    for(var name in variables){
        console.log("variable name: " + name);
        console.log(variables[name]);
    }

    戻り値 Object

    変数名を項目名とする配列型の変数。

getVariableValue

  • getVariableValue(variableName: string): any
  • コマンド実行時の変数の値を取得します。

    使用例
    Forguncy.CommandHelper.getVariableValue("variableName");

    引数

    • variableName: string

      変数名。

    戻り値 any

    変数の値。

setVariableValue

  • setVariableValue(variableName: string, value: any): void
  • コマンド実行時に変数に値を設定します。

    使用例
    Forguncy.CommandHelper.setVariableValue("variableName", 123);

    引数

    • variableName: string

      変数名。

    • value: any

      変数の値。

    戻り値 void