3.9.13 Text Label SubstitutionText-Label-Options
Label Option
When making graphs of worksheet or matrix data, most auto-generated labels -- including axis titles and graph legends -- are created by assigning plot metadata to a named label object. Each of these named label objects is saved in the graph template as an "empty", predefined string of characters which map to various bits of plot metadata. We refer to the run-time assignment of plot metadata to these labels as "substitution" and the syntax used to construct the "empty" strings as "substitution notation."
List of @Options
Below is a table of available @ text-label options for customizing the text labels, including legend text and axis title. See the screenshots for the worksheet properties which will be referenced by the sample expressions:
Column Label Rows
@ Option
|
Substitute Text From..
|
Example
|
@LS / @C
|
Column Short Name
|
%(1,@LS) --> B %(1,@C) --> B
|
@LA
|
Long Name, if available, else Short Name.
|
%(1,@LA) --> Delta Temperature
|
@L / @LL
|
Long Name, will return to missing value if long name does not exist. Equivalent to @LL.
|
%(1Y,@L) --> Delta Temperature %(1,@LL) --> Delta Temperature
|
@LG / @U
|
Long Name (if not available then Short Name) and Units (if present). Equivalent to @LG
|
%(1,@LG) -->Delta Temperature (K) %(1,@U) -->Delta Temperature (K)
|
@LC
|
Comments, if available, else Long Name, otherwise Short Name
|
%(1,@LC) --> YBCO milled
|
@LC[n]
|
The nth line of the Comments label row cell. Note that n is optional and that @LC1 = @LC.
|
%(1,@LC2) -->milled
|
@LM
|
1st line of Comment, if available, else Long Name, otherwise Short Name.
|
%(1,@LM) --> YBCO
|
@LN
|
1st line of Comments (if not available then Long Name, otherwise Short Name) and Units. Equivalent to @(@LM(@LU)).
|
%(1,@LN) --> YBCO(K)
|
@LU
|
Units
|
%(1,@LU) --> K
|
@LUP,@LUS,@LUA,@LUC
|
Add brackets to Units. Parentheses = (), Square brackets = [], Angle brackets = <>, Curly brackets = {}
|
%(1,@LUA) --> <K>
|
@LD
|
The first user-defined parameter
|
%(1,@LD) -->'S21
|
@LD[n]
|
The nth user-defined parameter. Note that n is optional and that @LD1 = @LD.
|
%(1,@LD2) -->235
|
@LD"name"
|
The user-defined parameter of specified name.
|
%(1,@LD"RunNo")-->07
|
@LH
|
The name of the first User-Defined Parameter.
|
%(1,@LH) -->UserDefined
|
@LQ
|
The first User-Defined Parameter and Units (if available).
|
%(1,@LQ) --> S21(K)
|
@LQ[n]
|
The nth User-Defined Parameter and Units (if available). Differs from @LH by including Units. Note that n is optional and that @LQ1 = @LQ.
|
%(1,@LQ2) --> 235(K)
|
@LQ"name"
|
The User-Defined Parameter (specified by name) and Units (if available).
|
%(1,@LQ"RunNo") --> 07(K)
|
@LH[n]
|
The name of nth User-Defined Parameter. Note that n is optional and that @LH1 = @LH.
|
%(1,@LH3) -->RunNo
|
@LP
|
The first System Parameter.
|
%(1,@LP) --> Version 2.1
|
@LP[n]
|
The nth System Parameter. Note that n is optional and that @LP1 = @LP.
|
%(1,@LP2) --> 12/15/2004
|
@LF[n]
|
The filter condition of the data plot. When there are multiple conditions, optional n = the nth line of filter condition (list order shown in Filter label row cell). Also, see LabTalk system variable @SFD
|
Make = %(1,@LF)-->Buick
|
Workbook Information
@ Option
|
Substitute Text From..
|
Example
|
@WL
|
Long Name of book (workbook, matrix)
|
%(1,@WL) -->S21-235-07
|
@W
|
Short Name of book (workbook, matrix)
|
%(1,@W) -->Book1
|
@WC[n]
|
The nth line of the WorkBook Comment. If optional n is not specified, only the first line will be shown.
|
%(1,@WC2) -->
<Origin EXE Folder>\Samples\Curve Fitting
|
@WS
|
Name of the sheet (workbook, matrix)
|
%(1,@WS) -->Trial Run 2
|
@WNL
|
Long Name of sheet (workbook, matrix)
|
%(1,@WNL) -- See LabTalk System Variable @SSL
|
@WNS
|
Short Name of sheet (workbook, matrix)
|
%(1,@WNS) -- See LabTalk System Variable @SSL
|
@WM[n]
|
The nth line of the WorkSheet Comment. If optional n is not specified, only the first line will be shown.
|
%(1,@WM) -->Data imported from
|
@WN
|
The contents of the cell Note.
|
*%(1,@WN,1)
- Content of Note in source column of 1st plot, row[1].
- %(1,@WN,B,3)
- Content of Note in col(B), row[1] in current plot's data sheet.
- %(1,@WN,C)
- Content of Note in source column's Comment Cell.
- %(1,@WN,B,L)
- col B LN Cell Note in current plot's data sheet
- %([book1]1,@WN,col(B)[L])
- col B LN cell Note in given sheet
|
@WP
|
Project Explorer (PE) path of the book (workbook, matrix)
|
%(1,@WP) -->/Folder1/
|
Worksheet Cell Access
@ Option
|
Substitute Text From..
|
Example
|
@L, n
|
The X value of the nth point in the data plot.
|
* %(1, @L, 2)
- means the X value of the 2nd data point in the 1st data plot.
|
@V, n
|
The Y value of the nth point in the data plot.
|
* %(1, @V, 2)
- means the Y value of the 2nd data point in the 1st data plot.
|
@WT, ColIndex/ColName, RowIndex
|
The sheet cell value specified by the column index (or short name) and row index.
|
*%(1, @WT, 2, 3)
- the cell value at column 2, row 3 in the source sheet (worksheet, matrix) of the 1st data plot.
- $( %(1, @WT, 2, 3,.4 ) * 100, .2 )
- Because it's numeric, get column 2, row 3 value, keep 4 decimal places, times by 100, then format to show 2 decimal places
- %(1, @WT, B, 3)
- the cell value at column B, row 3 in the source worksheet of the 1st data plot.
|
@WT, ColIndex/ColName, ColLabelRowCharacter
|
The worksheet cell value specified by the column index (or short name) and column label row character.
|
*%(1, @WT, B, C)
- Similar to B[C]$, this will get the Comment from column B, in the source worksheet of the 1st data plot.
|
Plot Information
@ Option
|
Substitute Text From..
|
Example
|
@GG
|
Group Name of current plot in a graph
|
%(2, @GG)
- Show the group name of current plot. The default group name g# will show as blank.
|
@GL
|
Layer Name of current plot in a graph
|
%(2, @GL)
- Show the layer name of current plot. The default layer name Layer# will show as blank.
|
@L[n]
|
The information of current plot:
@L1: Plot Index
@L2: Group Name
@L3: Layer Name
|
%(1,@L1) --> 1
%(1,@L2) --> g1
%(1,@L3) --> Layer1
|
@LX
|
Plot Designation Index. When you have columns A(X1), B(Y1), C(X2) and D(Y2), plot then into a graph, you can use @LX to get the desinagtion index and show 1, 2 in the legend text.
|
%(1,@LX) --> 1
|
@V"above"/@V"below"
|
Use in Fill Area Under Curve graph only. When Fill to next data plot - Above Below Color is selected, this notation is used for labels to indicate the filled-color above / below base curve.
|
%(1, @V"above")
%(1, @V"below")
--> Above B Below B
|
Dataset/Range Information
@ Option
|
Substitute Text From..
|
Example
|
@D
|
Dataset name
|
%(?Y,@D) --> Book1_B
|
@R
|
Dataset range
|
%(1,@R) -->
[Book1]"Trial Run 2"!Col("Delta Temperature")[1:32]
|
@R1
|
Dataset range without row index
|
%(1,@R1) -->
[Book1]"Trial Run 2"!Col("Delta Temperature")
|
@RB
|
Starting row index of the plotted data
|
%(1,@RB) -->
1
|
@RE
|
Ending row index of the plotted data, same as @RN if @RB is 1
|
%(1,@RE) -->
32
|
@RN
|
Total number of rows in the plotted data (will not exclude missing values or masked data points)
|
%(1,@RN) --> 32
|
Holder Book Information
@ Option
|
Substitute Text From..
|
Example
|
@PLE
|
Holder Book Long Name. Returns the Long Name of container workbook for embedded Graph, Matrix, Notes or HTML Report.
|
%(%H,@PLE)
|
@SC
|
Holder Sheet Comment. Returns the Comment of sheet for an embedded Graph, Matrix, Notes or HTML Report.
|
%(%H,@SC)
|
@SN
|
Holder Sheet Display Name; if Label exists use Label. Returns the Display Name or Label of sheet for an embedded Graph, Matrix, Notes or HTML Report.
|
%(%H,@SN)
|
@SNL
|
Holder Sheet Label. Returns the Label of sheet for an embedded Graph, Matrix, Notes or HTML Report.
|
%(%H,@SNL)
|
@SNS
|
Holder Sheet Name. Returns the Name of sheet for an embedded Graph, Matrix, Notes or HTML Report.
|
%(%H,@SNS)
|
Note: When units are displayed in the substituted texts, the English and Japanese versions of Origin enclose the units in parentheses (), while the
German version will use square-brackets [].
|