Xファンクションビルダ

ツール:XファンクションビルダをクリックしてXファンクションビルダを開きます。

Xファンクション名

Xファンクション編集ボックスでXファンクション名を入力します。

Xファンクションの名前として、既存のLabTalkマクロ、OGSファイル、LabTalkコマンド、LabTalkで呼び出し可能なOriginC関数の名前は使用しないでください。

同じ名前のものがある場合、呼びだされる順番は、LabTalkマクロ > LabTalk OGS > Xファンクション > LabTalkで呼び出し可能なOriginC関数 > LabTalkコマンド の順になります。


Xファンクション変数

名前

変数の名前を指定します。Xファンクションがスクリプトで実行されるとき、その名前を使って、変数に値を割り当てる必要があります。そのため、異なる文字で始まる短い名前にすることをおすすめします。

ラベル

変数のラベルを指定します。特殊記号やスペースを使うことができます。制御ラベルとしてXファンクションダイアログ上に表示します。 指定しない場合、変数名が使用されます。

入力/出力

変数が入力、出力、入出力のどのタイプで使用されるかを指定します。

データ型

変数のデータ型を指定します。

詳細は 変数のデータ型とデフォルト値 セクション内で参照できます。

データ

変数のデフォルト値を指定します。詳細は 変数のデータ型とデフォルト値 セクション内で参照できます。

制御

ダイアログボックスでの変数のコントロール(コンボボックス、スライダーなど)を指定します。

詳細は 制御型セクション内で参照できます。

オプション文字列

変数に対するオプション文字列を指定します。グループのいくつかの変数を一緒にしたり、再計算を有効にするなど、オプション文字列で詳細設定を適用できます。詳細は、オプション文字列セクションの下を参照してください。

テーマID

変数のテーマIDを指定します。割り当てない場合、変数のテーマIDは変数のインデックスを参照します。テーマIDは、Xファンクションダイアログ用のテーマファイルで使用されます。

詳細はテーマIDのセクションを参照してください。

変数データタイプとデフォルト値

Xファンクションは、下記のように様々なデータ型を提供します。

  1. 基本データ型
    • データ型は double, string, int
    • デフォルト値は、数値に対しては0、文字列に対しては空です。
  2. Originの合成データ型
    • データ型はvector、vector<string>、vector<complex>、matrix
    • 例えば、vectorはワークシート列を入力または出力に接続できます。
    • デフォルト値は <active>、<new>、<unassigned>にできます。
    • 詳細はOrigin CヘルプのComposite Data Typesを参照してください。
  3. Originオブジェクトタイプ
    • データ型は、Column、Range、GraphLayer 、および他のOriginオブジェクトタイプ
    • デフォルト値は <active>、<new>、<input>、<unassigned>にできます。
    • Origin C は、GetNツリー文字列値からOriginオブジェクトを取得するBOOL okxf_resolve_string_get_origin_object(LPCSTR lpcsz, OriginObject* pObj) 関数を提供します。
    • 詳細は、Origin CヘルプのInternal Origin Objectsをご覧ください。
  4. TreeNodeタイプ
    • データ型は、TreeNode, ReportData, ReportTreeです。TreeNode iは入力、ReportData および ReportTreeは出力です。
  5. Origin図形オブジェクトコントロール
    • データ型はButtonInfo, LineInfo, TextInfoなどです。
    • Xファンクションビルダで組み込みXファンクションOriginEXE\X-Functions\Data Manipulation\curve translate.OXFを開き、サンプルとして使用法を見ることができます。
  6. レポートタイプ

制御型

Xファンクションビルダ内の制御列の変数グリッドで異なる制御文字列を指定したら、Xファンクションダイアログでのユーザインターフェースコントロールの異なるタイプを簡単に作成できます。

使用方法 データ型 制御文字列
数値編集ボックス double  
テキスト編集ボックス string  
チェックボックス int 0|1
コンボボックス int
  • string1|string2|string3
  • CaseA:string1|CaseB:string2|CaseC:string3
編集可能なコンボボックス string 変数グリッドの制御列を空白のままにし、下記のコードをxfname_before_execute function 関数 に追加して、var 変数制御を編集可能コンボボックスとしてセットします。
if( nGetNDialog > 0 )
    trGetN.var.SetAttribute(STR_COMBO_ATTRIB, "|aa|bb|cc");
ラジオボックス int Radio:string1|string2|string3
スライダー int/double slider:start|end|nstep
カラーリスト int
  • ColorList, 24 の基本的なカラーパネル
  • Color0, 通常のカラーパネル
グラフブラウザ string
  • ...Graph - 単一グラフ
  • ...Graphs - 複数グラフ

Originは制御文字列GraphBrowserFilterを使って、Origin C関数でグラフブラウザのインターフェース設定をサポートします。詳細は、Xファンクショングラフブラウザダイアログのサンプル をご覧ください。

ファイル参照ボタン付きテキスト編集ボックス string
  • ...File - 単一ファイル
  • ...Files - 複数ファイル
グラフ参照ボタン付きテキスト編集ボックス string
  • ...Path, フォルダ選択ダイアログを開きます
  • ...Path2, フォルダ参照ダイアログを開きます

Note: システム変数@FBL = 0 に設定すると、新しいフォルダブラウザと古いフォルダブラウザの切り替えが可能です。...Pathを指定するとフォルダの参照ダイアログが開き、...Path2を指定するとフォルダの選択ダイアログが開きます。

名前を付けて保存ブラウザボタン付きテキスト編集ボックス string ...Save

オプション文字列

オプション文字列で特殊文字列をセットし、変数の操作を指定できます。 例えば、再計算をデフォルトモードでセットしたり、数値の桁数をセットしたり、出力オブジェクトのデフォルト名をセットできます。詳細は、リファレンス:Xファンクションのオプション文字列をご覧ください。

テーマID

テーマIDは、Xファンクションダイアログテーマファイルで使われ、デフォルト値は0です。すべての変数のテーマIDを0(デフォルト)にする場合、テーマファイル内のテーマIDは1から始まる変数のインデックスに従って変換されます。

既存のテーマファイルと互換性を持たせるために、変数を既存のXファンクションに挿入したいとき、以下のようにする必要があります。(変数を最後に追加する場合は必要ありません)

  1. 変数を挿入する前に、テーマIDを0から変数のインデックスに変更します。
  2. 変数を挿入します。
  3. 繰り返しを避けるため、挿入した変数のテーマIDを最大値にします。

ツリービュー

ツリービューボタンOcguide xf treeview button.pngをクリックしてツリービューに切り替えます。ツリービュー内の設定は、Xファンクションダイアログを作成したり、OriginメニューにXファンクションを追加したり、ドキュメントを追加する時に主に使用されます。詳細は、次の章のXファンクションを編集するを確認してください。

Ocguide xf treeview.png