3.9.10 Access to Column Label Row Data

Column-Label-Row-Characters

Introduction

Worksheet column label rows typically contain metadata associated with one or more columns of data (datasets). This metadata is accessible via LabTalk script or at various places in the user-interface. Please note:

• Syntaxes for accessing metadata from script -- as well as GUI access using the wcol(n) function -- make use of the Column Label Row Properties in this table.
• Syntaxes for accessing metadata in the GUI (axis title, legend, etc.) generally make use of the @options listed on this page.

Note that the above elements support substitution of other types of project data including cell data, project and import file metadata, project variables, etc. For a broader discussion of substitution usage by element, follow the links in the Element column.

Notes can be inserted to any worksheet column label row cell and that note can be used to add content to a graph or layout page, using a "@@@NotesN" syntax.

Column Label Row Properties

When writing LabTalk scripts LabelColumn Label RowLabel Row CharacterWorksheet label rows are accessed using the following characters as row indices. Note that you can find all column label row characters in the Column Label Rows dialog.

Examples

//Show, Hide or Move Column Label Rows
wks.labels(0); //Hide all column label rows
wks.labels(@); // When import adds Units, move Units between Long Name and Comments, F(x)= to bottom 
wks.labels(LUCO); //Show long name, units, comments and F(x) rows
wks.labels(+EF);  //Add Sampling Interval and Filter rows to the top
wks.labels(*P1O1); // Add Column Parameter 1, Categories rows to the bottom
wks.labels(-F); //Hide Filter row
wks.labels(>C); //Move Comments row to bottom of label rows
wks.labels(#D1); //Clear the content and hide the User Parameter 1 label row


// Write long name, units, comments, and parameter1 of column B
col(B)[L]$ = "Temperature"; // Long name
col(B)[U]$ = \+(o)C; // Units
col(B)[C]$ = "Temperature vs Time"; // Comments
col(B)[P1]$ = "Site 1"; // The 1st Parameters row
 
// Set Sampling Interval of column B
wks.col2.xinit = 0.1;  // init value
wks.col2.xinc = 0.001;  // interval
wks.col2.xunits$ = "s";  // units
wks.col2.xname$ = "Time";  // name
 
// Define F(x) cell of column C to set values
col(B)=normal(32); //fill column with normal random values
col(C)[O]$="col(B)*2"; //enter formula to calculate values in column C
//wks.col3.formula$="col(B)*2"; //use formula$ is fine as well

//Show sparklines
wks.labels(*S); //Add Sparklines row at the bottom
sparklines sel:=0 c1:=1 c2:=3; //use sparklines x-function to plot sparklines

//Set Column A as Categorical and read strings in Categories cell
patternT irng:=col(A) mode:=random text:="NY LA GZ HK" onerepeat:=2 seqrepeat:=4; //Fill column A with random text
set col(A) -dc 1; //Set column A as Categorical
col(A)[O1]$=; //Read strings in Categories cell
string str1$ = col(A)[O1]$; //Read strings in Categories cell to a string variable;
str1$=; 
 
// Add User Defined Parameter 1 and access it using D1 character
wks.labels(*D1); //Show 1st User Defined Parameter 
wks.UserParam1$ = "Mean"; //Rename 1st User Defined Parameter as Mean
col(B)[D1]$ = $(mean(Col(B)),*3); //Put mean of column B in Mean label row, keep 3 significant digits

//Add User Defined Parameter 2 and access it using real user parameter name
wks.userparam2 = 1; //Show Size column label row, same as wks.labels(*D2);
wks.userparam2$ = Size; //Define 2nd User Defined Parameter Size
col(B)[Size]$ = $(count(Col(B),1),.0); //Put size of column B in Size row, 0 decimal places.

//From Origin2025 D0 is changed to refer to last created user parameter row instead of 1st user parameter row. 
Col(B)[D0]=; //column B’s last user parameter row value
wks.merge(D0, 1); //merge last user parameter row if neighbouring texts are the same

Column label rows contain metadata, or information about the data contained in the column. Please see the Accessing Metadata section for detailed notes on their use.