Wks

例：

range aa=[book1]sheet2!;
// 固定を維持するために行の自動追加を無効化
// 列数と行数
aa.AutoAddRows=0; 
// 3x2のワークシートを作成
aa.nCols = 2;aa.nRows = 3;

(2023)

システム変数@WBCを参照して縞模様の色を変更し、@WBEを参照して塗りつぶす行を奇数と偶数の間で切り替えます。

アクティブなワークシートの列幅。

wcolwidth Xファンクションやwks.col.widthも参照してください。これらは個々の列の幅を設定するのに使うことができます。

(2025)

//1番目の列をx,2番目の列をyに設定。これ以降の列属性は指定していないため、全てYになる
wks.colxy$=xy; 

// 1番目の列は無属性、残りの列はxyのペアを繰り返す
wks.colxy$=n(xy); 

// 1番目の列を無属性、2番目列をラベル、最後の列をzに設定。
// その間の列はxyのペアを繰り返す
wks.colxy$=nl(xy)z;

(2023b)

(2019b SR0)

システム変数@TCEを使用して、@TCE=Color(255, 60, 60)のように任意の色でタグ付き（除外）シート名を指定できます。

// 以下はユーザーがセルD4を選択し、
//ミニツールバーのウィンドウ枠の固定ボタンをクリックするのと同様
wks.frozen$="C 3"; // 列A~C、行1~3を固定
wks.frozen$=""; // 列A~C、行1~3の固定解除

(2019b SR0)

0 =ワークブックにデータコネクタがない、
1 =ワークシートがデータコネクタによって出力(宛先シート)として使用されている、
2 =ワークシートがどのデータコネクタによっても出力として使用されていない。この場合、ワークシートにデータコネクタが含まれているが、有効な接続が構築されていません。ワークシートがデータコネクタによって出力として使用されているかどうかを確認するには、 "wks.DC.Valid"を使用します。

(2019 SR0)

(2021b)

0 = プロットと解析に非表示行のデータを含める。
1 = （デフォルト）プロットと解析で非表示行を無視する。

このプロパティを使用してワークシートを並べ替えます。例：

newbook sheet:=4; // 4つのシートを持つワークブックを作成;
wks.index = 3; // "Sheet1"をワークシートの3番目に移動;

Note: このプロパティは 8.5.0 SR1より前のバージョンでは読み取り専用です。

0=インポート時に列幅を調整しない。
1=（デフォルト）システム変数@ISCの値に従う。

0=列名が一致する場合は列挙する。一致する行が見つからない場合は追加する。

1=列名が一致する場合は削除する。一致する行が見つからない場合は追加する。

2=列名が一致する場合は列挙する。一致する行が見つからない場合は削除する。
3=列名が一致する場合は削除する。一致する行が見つからない場合は削除する。
wks.join() メソッドを参照してください。

(2018 SR0)

(2023)

システム変数@WPOで保護されたワークシートの例外を設定します。

例：

// 約5文字分の高さに設定
range aa=2!; // アクティブなブックの2番目のシート
aa.rhw=50;

wks.UserParam1=1; // 最初のユーザパラメータを表示

// パラメータ名を "Site Index"に設定
wks.UserParam1$="Site Index";

(2020b)

例：

 //列1と2にユーザパラメータ "File Name" を追加し、その内容を "some file name"とする
wks.AddUD("File Name", "some file name", 1:2);

//2列目にユーザパラメータ行 "FileName" を追加し、その内容を "some file name"とする
wks.AddUD(FileName, "some file name", 2); 

//2列目から最後の列にユーザパラメータ行 "File" を追加し、その内容を "F1.dat"とする
wks.AddUD(FileName, "F1.dat", 2:end);

行の範囲の削除。rowBeginのみを指定すると、ワークシート内のすべての列のrowBeginが削除されます。
numRowsオプションを追加すると、rowBeginからすべての列のnumRowsが削除されます。
colBeginとcolEndを使用して、行の削除を指定された列に制限できます。 (a) colBeginからシートの最後の列まで（colEndの指定なし）、または (b) colBeginからcolEndまでです。

rowBeginが指定されていないか0に設定されている場合、選択された範囲は削除されます。この場合、Undoは「元に戻す」をサポートするかどうかを決定します。 undo: 0 = 元に戻すをサポートしない（デフォルト）、 1 = 元に戻すをサポートする。例えば、

// 選択した行を削除（「元に戻す」不可）
wks.DeleteRows(); 

// 列Bの値が5000未満の行、または欠損値の行を選択し削除
wxt test:="col(B)<5000 or IsNA(col(B))" sel:=1;
wks.DeleteRows(0,1);

その他の例はこちらを参照してください。
また、下記のwks.insertRowsも参照してください。

(2023b)

// col(B) < 5000の行を非表示にするフィルタを追加
wks.col2.filter = 1;
wks.col2.filter$="x>5000";
wks.runfilter();
// 非表示行を削除
wks.DelHidden(0,1);
wks.col2.filter=0;
wks.nrows=wks.maxrows;

Note: 列リストビューではwks.DelHidden() が無効になっています。

i=wks.findX(B);
i=;// 1を返す
i=wks.findX(A);
i=;// Col(A) は X列のため-3を返す

任意の列(Y列か否かに関係なく)に対して、wks.findX(colInex,0)を使用して列の指定を無視し、対応するX列インデックスを取得できます。

ToWksが指定されていない場合は、現在アクティブなワークシートが使用されます。

// ロングネームとコメントを表示（それらが空でない場合）
wks.labels();
// ラベル行を非表示
wks.labels(0);
// インポート時に単位を追加する場合は、単位をロングネームとコメントの間に移動して、F(x)=を一番下に移動
wks.labels(@);
// ロングネーム、単位、コメントの表示設定
wks.labels(LUC)
// コメント、ユーザパラメータ1、ロングネームを表示
wks.labels(CD1L)

プレフィクス+ 、-、*は以降のバージョンで使用できます。 Origin 8 SR2.
プレフィクス<、>は以降のバージョンで使用できます。 Origin 2017.
wks.labels(@) は以降のバージョンで使用できます。 Origin 2020b.
プレフィクス#は以降のバージョンで使用できます。 Origin 2024b.

// 単位を削除
wks.labels(-U);
// 上部にサンプリング間隔とスパークラインを追加
wks.labels(+ES);
// 最後に単位を追加
wks.labels(*U);
//  F(x)= to を最後に移動
wks.labels(>O);
//コメントを最初に移動
wks.labels(<C);
//User Parameter 1 ラベル行の内容をクリアして非表示
wks.labels(#D1);

+と*を使用してラベル行を上または下に「移動」(追加)することもできます。ラベル行がまだ表示されていない場合、<と>の記号は何もしません。

wks.labels(D*);

wks.merge(L,1);// LNを結合
wks.merge(L,0);//LNの結合解除
wks.merge(L,-1)=;//LNが結合されたら1、そうでない場合は0を返す

(2021b)

arg1 = ラベル型、arg2 = 読み取り専用。

wks.readonly("L")=;//ラベルが読み取り専用（編集不可）であるかどうかを取得
wks.readonly("L", 1);//ロングネームを読み取り専用に設定
wks.readonly("P1",-1);//読み取り専用プロパティを削除

readonly()は、ユーザ定義ラベルおよびパラメータラベルをサポートしています。以降のバージョンに対応しています。 Origin 2025, 読み取り専用プロパティの削除をサポートしています。以降のバージョンに対応しています。 Origin 2025.

arg1 =-1：現在の順序を逆にする。

wks.reorder(-1); //逆順にする

arg1 =列インデックス、arg2は新しいインデックス。

wks.reorder(2,5) //2番目の列を5番目に移動
wks.reorder(2, 0) //2番目の列を最後に移動
wks.reorder(2,-1) //2番目の列を最後から2番目に移動
wks.reorder(0, -1) //最後の列を最後から2番目に移動
wks.reorder(-1, 1) //最後から2番目の列を最初に移動

arg1 = dataset：順序の指定。

dataset vv = {1,4,3,2};
wks.reorder(vv);

type : ラベル型。L、C、U、Pなど。

rowNum : ラベルとして設定する行の番号（この行は削除されません）。-1=ラベルとして設定したときにアクティブな行を削除する（※このスクリプトを実行する前に行を選択する必要があります）。

label ：1=ラベル行を選択、0=データ行を選択。

append : 1=選択した行の内容をラベルに追加する（ロングネームとコメントの場合のみ有効）。 0=選択した行の内容を使用して元の内容を置き換える。

//2番目のラベル行をロングネームに設定
wks.SetAsLabel(L,2,1,0);

//4 番目のデータ行をコメントに追加
wks.SetAsLabel(C,4,0,1);

//最初のデータ行を単位に設定
//（最初のデータ行がアクティブである必要がある。 
// これはスクリプト実行後に削除される）
worksheet -s 0 1 0 1;  
wks.SetAsLabel(U,-1,0,0);

char以外のすべての引数はオプションです。

char =1つ以上の列ラベル行文字。複数のcharが与えられた場合、ソートはネストされます。
c1 =ソートの開始列。c1とc2が省略された場合、またはc1=0 、c2=-1の場合、ワークシート全体がソートされます。
c2 = ソートの終了列。
order = a （昇順）または d （降順）。orderが省略された場合、昇順でソートされます。
skipHidden = 数値。0以外の場合は、ソート中に非表示の列をスキップします。0または省略された場合は、非表示の列をスキップしません。

// ワークシート列を列のロングネームで昇順にソート
wks.sortCols(L); 
// ネストされたソート。ユーザ定義パラメータ (a) > ロングネーム (d)、全列、非表示列をスキップ
wks.sortCols(D1L,ad,,,1);

wks.userparam(Location)=;// ユーザパラメータ"Location"のインデックスを返す

新しいユーザパラメータを追加する場合は

wks.userparam(++Factor) // ユーザパラメータ"Factor"を追加