Layer.Plotn

LabTalk Object Type:

This page is for the plotting properties of layer.plot object or the sub-objects of the layer object for plotting.

1 Properties
- 1.1 Example
2 Sub Objects

Properties

Property	Access	Description
layer.plot0	Read/write, numeric	Access the active plot, while layer.plot refer to active plot’s group head
layer.plotn.aa	Read/write, numeric	Disable or enable anti-aliasing at the plot level: 0 = disable, 1 = enable for plot, 16 = enable for labels, 17 = enable for plot + labels.
layer.plotn.color	Read/write, numeric	Plot Color. See Also:color()
layer.plotn.colorlist$	Read/write, string	Color List
layer.plotn.contlines	Read/write, numeric	Whether enable contours, 1 = yes, 0 = no.
layer.plotn.contmat	Read/write, numeric	The matrix object for contour line
layer.plot.delaunayTriangulation	Read/write, numeric	Controls triangulation algorithm to be used in constructing XYZ contour plots. 0 = Behavior prior to v2016, triangulation and interpolation of arbitrary points in a plane 1 = Qhull algorithm 2 = Qhull fast mode (not reliable for collinear data)
layer.plotn.index	Read, numeric	Index of plot
layer.plot.name$	Read, string	return the dataset name of the main plot object
layer.plot.parametricx	Read/write, numeric/string	Parametric X Matrix. Numeric for index, string for range string
layer.plot.parametricy	Read/write, numeric	Parametric Y Matrix. Numeric for index, string for range string
layer.plotn.parent	Read/write, numeric	Source Plot Index of the fitted curves. If there are multiple curves in a layer and and multiple fits on the graph, it can get the index of the parent data plot for the fitted curve. And, for the source curves, layer.plotn.parent = 0.
layer.plotn.pid	Read, numeric	Plot type.
layer.plotn.shapelist$	write, string	Shape List
layer.plotn.show	Read/write, numeric	Set the nplot visible or not.
layer.plotn.subgroupsize (9.1 SR0)	Read/write, numeric	Set the size of subgroup. n should be the plot index of the first data plot in a group.
layer.plotn.subgrouplabelrow (2016 SR0)	Read/write, numeric	Set the column label row for subgrouping. n should be the plot index of the first data plot in a group. 1 = Long Name, 2 = Units, 3 = Comments, 4 = Sampling Interval, etc. Note that when this option is enabled, it will override layer.plotn.subgroupsize.
layer.plotn.subsetcol$	Read/write, string	Access the range string on Subset tab in Plot Details when enable subset by column. layer.plot.subsetcol$=[Book1]Sheet1!C
layer.plotn.subsetgap	Read/write, numeric	Gap between subsets, a percentage of the width of the columns/bars. Only available if subsetsize is not 0.
layer.plotn.subsetinc	Read/write, numeric	Access the Subset Increment option in Plot Details. 0 = none, 1 = within subset, 2 = between subset
layer.plotn.subsetsize	Read/write, numeric	Divide the columns into subsets by a specifying the subset size layer.plot.subsetsize=4
layer.plotn.transparency	Read/write, numeric	This controls how much the plot can be seen through, from 0 to 100
layer.plotn.usepropssubgroup (2016 SR0)	Read/write, numeric	Specify whether to use the increment list repeatedly in each subgroup or between subgroups. 0 = do not use increment, 1 = use increment list repeatedly within each subgroup, 2 = use increment list repeatedly between subgroups. n should be the plot index of the first data plot in a group.
layer.plotn.Tag$	Read string	When Analysis Tool is adding a data plot like for a peak marker, it will put in a tag.

Example

//import Group.dat and use col(B) make a scatter plot
layer.plot1.color = color(1,n);//plot color = Index : col(C) 
layer.plot1.colorlist$="Fire";

//import Group.dat and make a group plot
layer.plot.shapelist$="myShape";//a Increament List for Shape named "myShape" 

layer.plot.shapelist$={3, 2, 1};//by a temp dataset

Sub Objects

BoxChart

The layer.plotn.boxchart object is a sub-object of the layer object. It provides script access to the box chart options in the Plot Details dialog box.

Note: Replace n with the data list number of the box chart you want to edit.

Property	Access	Description
layer.plotn.boxchart.binBegin	Read/write, numeric	Minimum of the bin range.
layer.plotn.boxchart.binEnd	Read/write, numeric	Maximum of the bin range.
layer.plotn.boxchart.binSize	Read/write, numeric	Size of the bins.
layer.plotn.boxchart.boxRange	Read/write, numeric	Box range, as in no box, SE, SD, Perc 25, 75, etc. 1 = no box, 2 = SE, 3 = SD, etc. See the Range drop-down list on the Plot Details Box tab.
layer.plotn.boxchart.label	Read/write, numeric	Box labels setting, 1 = mean, 2 = median, 3 = both
layer.plotn.boxchart.line	Read/write, numeric	Box lines setting, 1 = mean, 2 = median, 3 = both
layer.plotn.boxchart.type	Read/write, numeric	Type of box chart, as in box, data, box and data, etc. 1 = box, 2 = data, 3 = box and data, etc. See the Type drop-down list on the Plot Details Box tab.
layer.plotn.boxchart.width	Read/write, numeric	Box width, in points.

Contour Label

The layer.plotn.contourlabels object is a sub-object of the layer object. It provides script access to the contour label options in the Plot Details dialog box.

Note: Replace n with the data list number of the contour plot you want to edit.

Property	Access	Description
layer.plotn.contourlabels.bold	Read/write, numeric	Whether set the font bold, 1 = yes, 0 = no.
layer.plotn.contourlabels.color	Read/write, numeric	Set color for the contour labels by using the color index, such as 1 = black, 2 = red, 3 = green, 4 = blue, etc. See the color list in the appendix.
layer.plotn.contourlabels.font	Read/write, numeric	Set font for the contour labels, by the index of the current font list.
layer.plotn.contourlabels.italic	Read/write, numeric	Whether set the font italic, 1 = yes, 0 = no.
layer.plotn.contourlabels.minarea	Read/write, numeric	Set a percent value such that only contours that have a fraction of the total area larger than the this value will have a label associated with them.
layer.plotn.contourlabels.size	Read/write, numeric	Set font size for the contour labels, in the unit of points.
layer.plotn.contourlabels.underline	Read/write, numeric	Whether enable underline of the contour labels, 1 = yes, 0 = no.
layer.plotn.contourlabels.whiteout	Read/write, numeric	Whether display a white background behind each data label value, 1 = yes, 0 = no.

Label

Property	Access	Description
layer.plot.label.color	Read/write, numeric	Active data plot label color. layer.plot.label.color=2 // LabTalk list of colors (1=black, 2=red, 3=green, etc.) layer.plot.label.color=color(#FF0000); // use color function with HTML, RGB values
layer.plot.label.datagap	Read/write, numeric	Gap between leader line and data point(%)
layer.plot.label.form$	Read/write, string	Active data plot label form. Set Label Form to Custom and specify Format String layer.plot.label.form$=%(?,@LL); // label using column Long Name
layer.plot.label.fsize	Read/write, numeric	Active data plot label font size, in points.
layer.plot.label.labelgap	Read/write, numeric	Gap between leader line and text frame(%)
layer.plot.label.leader	Read/write, numeric	Show leader line. -1: hide; 2 = show with 2% threshold
layer.plot.label.spec$	Read/write, string	Enable show data labels only at points specified: layer.plot.label.spec$="end"; // enables display of label at last data point layer.plot.label.spec$="1 10 20 30"; // enables display of labels at point indices 1, 10, 20, 30. layer.plot.label.spec$="<subset end>";//show plot label on subset boundary If labels are not enabled, enable labels. To turn off the Show at Specified Points Only box (Plot Details Label tab), use layer.plot.label.spec$=""; // clear "Show at Specified..." check box To disable label display altogether, use set -q set %C -q 0; // turn off labels for active plot

Numeric Formats

The layer.plotn.numericformats object is a sub-object of the layer object. It provides script access to the numeric formats options in the Plot Details dialog box.

Note: Replace n with the data list number of the contour plot you want to edit.

Property	Access	Description
layer.plotn.numericformats.subformat	Read/write, numeric	Set the display format for the numeric contour labels, by using the index of the display format, including 1 = Decimal: 1000, 2 = Scientific: 1E3, 3 = Engineering: 1k, and 4 = Decimal: 1,000.
layer.plotn.numericformats.divideby	Read/write, numeric	The color map and contour levels will be divided by this specified value.
layer.plotn.numericformats.digimode	Read/write, numeric	Set the digit mode for specifying how to display the digits, 0 = Decimal Places, 1 = Significant Digits.
layer.plotn.numericformats.digits	Read/write, numeric	Set the number of digits to display. If layer.plotn.numericformats.digimode = 0, this value will set the number of digits after the decimal place, if layer.plotn.numericformats.digimode = 1, this value will set the number of digits to display.
layer.plotn.numericformats.prefix$	Read/write, string	Specify a prefix string for the contour labels.
layer.plotn.numericformats.suffix$	Read/write, string	Specify a suffix string for the contour labels.

Symbol

The layer.plotn.symbol object is a sub-object of the layer object. It provides script access to symbol options in the Plot Details dialog box. Plot number n can be omitted when the plot is active.

Property	Access	Description
layer.plot.symbol.interior	Read/write, numeric	Plot symbol interior.
layer.plot.symbol.kind	Read/write, numeric	Plot symbol shape.
layer.plot.symbol.oct	Read/write, numeric	Symbol Center when Overlapped Points Offset Plotting is enabled.
layer.plot.symbol.offset	Read/write, numeric	Symbol Arrangement when Overlapped Points Offset Plotting is enabled. 1 = Horizontal, 2 = Vertical.
layer.plot.symbol.size	Read/write, numeric	Symbol size. Units are whatever is set in the Size Unit list.
layer.plot.symbol.sizeFactor	Read/write, numeric	Symbol size scaling factor.
layer.plot.symbol.transparency	Read/write, numeric	Transparency, in percentage (%).

Line

The layer.plotn.line object is a sub-object of the layer object. It provides script access to line options in the Plot Details dialog box. Plot number n can be omitted when the plot is active.

Property	Access	Description
layer.plotn.line.connect	Read/write, numeric	line plot connect option, equal to Connect box in Line tab of Plot Details dialog.
layer.plotn.line.type	Read/write, numeric	Plot the curve as specified line style. The values for line style follow the index of the Style drop-down list in Line tab of Plot Details dialog, such as 1= Solid; 2 = Dash; 3 = Dot, etc..
layer.plotn.line.width	Read/write, numeric	Plot the curve line in specified width. The width is equal to Width box in Line tab of Plot Details dialog.
layer.plotn.sortx	Read/write, numeric	Sort columns by X values to plot the line.