Wks

Example:

range aa=[book1]sheet2!;
// Disable auto add rows to maintain fixed 
// number of rows and columns
aa.AutoAddRows=0; 
// Setup the wks with 3x2
aa.nCols = 2;aa.nRows = 3;

(2023)

Refer to system variable @WBC to change the banded color, and @WBE to switch the fill-color rows between odd and even.

Column width of the active worksheet.

Also see the wcolwidth X-Function or wks.col.width both of which can be used to set the width of individual columns.

(2023b)

(2019b SR0)

You use the system variable @TCE to indicate the tagged(excluded) sheet name with desired color, such as @TCE=Color(255, 60, 60);.

// The following is equivalent to the user selecting cell D4 and clicking the Freeze Panes Mini Toolbar button.
wks.frozen$="C 3"; // freeze cols A to C, rows 1 to 3
wks.frozen$=""; // unfreeze cols A to C, rows 1 to 3

(2019b SR0)

0 = workbook doesn't have Data Connector,
1 = worksheet is used by a Data Connector as the output (destination sheet),
2 = worksheet is not used by any Data Connector as the output. Iin this case, the worksheet may contain a Data Connector but doesn't build a valid connection. To check if the worksheet is used by a Data Connector as output or not, use "wks.DC.Valid".

(2019 SR0)

(2021b)

0 = Include data in hidden rows on plotting and analysis.
1 = (default) Ignore hidden rows on plotting and analysis.

Use this property to reorder worksheets. For example:

newbook sheet:=4; // Create a 4 sheets workbook;
wks.index = 3; // Move "Sheet1" to the 3nd worksheet;

Note: This property is Read Only before 8.5.0 SR1.

0 = Do not adjust column width on import.
1 = (default) Follow the value of system variable @ISC.

0 = enumerate when column names match. Append when matching rows are not found.

1 = drop when column names match. Append when matching rows are not found.

2 = enumerate when column names match. Drop when matching rows are not found.
3 = drop when column names match. Drop when matching rows are not found.
See the wks.join() method.

(2018 SR0)

(2023)

Set exception for protected worksheet by system variable @WPO.

Example:

// Set to about 5 char height
range aa=2!; // 2nd sheet of active book
aa.rhw=50;

wks.UserParam1=1; // Show the first user parameter

// Set parameter name as "Site Index"
wks.UserParam1$="Site Index";

(2020b)

Delete a range of rows. Specifying only rowBegin deletes rowBegin in all columns in the worksheet.
Adding option numRows deletes numRows from rowBegin, in all columns.
Use colBegin and colEnd to limit deletion of rows to specified columns, from (a) colBegin to the last column in the sheet (colEnd not specified), or (b) from colBegin to colEnd.

If rowBegin is not specified or set to 0, selected range will be deleted. In this case, Undo will determine whether to support undo: 0 = do not support undo (default), 1 = support undo. For example,

// delete seleted rows without undo
wks.DeleteRows(); 

// select rows where column B < 5000 or contains missing, and then delete them
wxt test:="col(B)<5000 or IsNA(col(B))" sel:=1;
wks.DeleteRows(0,1);

See more examples here.
Also, see wks.insertRows, below.

(2023b)

// add a filter to hide all rows where col(B) < 5000
wks.col2.filter = 1;
wks.col2.filter$="x>5000";
wks.runfilter();
// delete hidden rows
wks.DelHidden(0,1);
wks.col2.filter=0;
wks.nrows=wks.maxrows;

Note: wks.DelHidden() is disabled in column list view.

i=wks.findX(B);
i=;//return 1
i=wks.findX(A);
i=;//return -3 since Col(A) is X column

For any column (no matter Y column or not), use wks.findX(colInex,0) to ignore column designation and reture corresponding X column index.

If ToWks is not specified, then the currently active worksheet is used.

// Show Long Name and Comments, if they are not empty
wks.labels();
// Do not show any label rows
wks.labels(0);
// When import adds Units, move Units between Long Name and Comments, F(x)= to bottom
wks.labels(@);
// Set to show long name, units and comments
wks.labels(LUC)
// Show Comments, User Parameter 1, and Long Name
wks.labels(CD1L)

The prefixes +, - and * were added in Origin 8 SR2.
The prefixes < and > were added in Origin 2017.
wks.labels(@) added in Origin 2020b.

// To remove Units
wks.labels(-U);
// To insert Sample Rate and Sparklines at the top
wks.labels(+ES);
// To append Units to the bottom
wks.labels(*U);
// To move F(x)= to the bottom
wks.labels(>O);
//To move Comments to the top
wks.labels(<C);

Note that you can also use + and * to "move" (add) a label row to top or bottom. The characters < and > will do nothing if the label row is not already shown.

wks.merge(L,1);//merge LN
wks.merge(L,0);//unmerge LN
wks.merge(L,-1)=;//return 1 if LN merged, 0 if not.

arg1 = -1: reverse current order

wks.reorder(-1); //reverse order

arg1 = column index, arg2 is its new index

wks.reorder(2,5) //moves 2nd column to be the 5th column
wks.reorder(2, 0) //moves 2nd column to be the last column
wks.reorder(2,-1) //moves 2nd column to be next-to-last column
wks.reorder(0, -1) //moves the last column to be next-to-last column
wks.reorder(-1, 1) //moves next-to-last column to be the first column

arg1 = dataset: specify orders

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

type : Label type , L, C, U, P, etc.

rowNum : The Number of the row to set as label (This row will not be removed); -1 = remove the active row when you set it as the label (Note: you need to select the row before running this script).

label : 1 = select the label row, 0 = select the data row.

append : 1 = append the content in the selected row to label (Only works for Long Name and Comments); 0 = use the content in the selected row to replace the original content.

//Set the second label row as the Long name.
wks.SetAsLabel(L,2,1,0);

//Append the fourth data row to the Comment.
wks.SetAsLabel(C,4,0,1);

//Set the first data row as the Unit.
//(The first data row should be active, 
// and it will be removed after running the script).
worksheet -s 0 1 0 1;  
wks.SetAsLabel(U,-1,0,0);

All arguments except char are optional:

char = one or more of these column row label characters. If multiple char are given, sorting is nested.
c1 = starting column to sort. If c1 and c2 are omitted or if c1=0 and c2=-1, entire workhseet is sorted
c2 = ending column to sort
order = a (ascending order) or d (descending order). If order is omitted, sort ascending
skipHidden = a numeric value. If non-zero, skip hidden columns during sort. If 0 or omitted, do not skip hidden columns.

// sort worksheet columns on column Long Name, in ascending order
wks.sortCols(L); 
// nested sort User-defined Parameter (a) > Long Name (d), all cols, skip hidden
wks.sortCols(D1L,,,ad,1);

wks.userparam(Location)=;// return User Parameter "Location"'s index

Add new User Parameter.

wks.userparam(++Factor) // add User Parameter "Factor"