ModifyLayout
ModifyLayout [/W=winName /I/M/Z] [bgRGB=(r,g,b[,a]), columns(obj)=c, fidelity(obj)=f, frame(obj)=f, height(obj)=h, left(obj)=l, mag=m, rows(obj)=r, top(obj)=t, trans(obj)=t, units=u, width(obj)=w]
The ModifyLayout operation modifies objects in the top layout or in the layout specified by the /W flag.
Parameters
Each parameter has the syntax:
key [(objectName )] = value
Each key parameter may take an optional objectName enclosed in parentheses. If "(objectName)" is omitted, all objects in the layout are affected.
Though not shown in the syntax, the optional "(objectName)" may be replaced with "[objectIndex ]", where objectIndex is zero or a positive integer denoting the object to be modified. "[0]" denotes the first object appended to the layout, "[1]" denotes the second object , etc. This syntax is used for style macros, in conjunction with the /Z flag.
The parameter descriptions below omit the optional "(objectName)".
The "units", "mag", and "bgRGB" keywords apply to the layout as a whole, not to a specific object and do not accept an objectName.
| bgRGB=(r,g,b[,a]) | Specifies the background color for the layout. r, g, b, and a specify the the color and optional opacity as RGBA Values. | ||||||||||
| columns=c | Specifies the number of columns for a table object. | ||||||||||
| fidelity=f |
| ||||||||||
| frame=f |
| ||||||||||
| gradient | See Gradient Fills for parameters and details. | ||||||||||
| gradientExtra | See Gradient Fills for parameters and details. | ||||||||||
| height=h | Sets the height of the object. | ||||||||||
| left=l | l is the horizontal coordinate of the left edge of the object relative to the left edge of the paper. | ||||||||||
| mag=m | Sets the on screen layout magnification where m is a value between 0.05 and 10. | ||||||||||
| m=1 corresponds to 100%. | |||||||||||
| Factors of two, such as m=.25, m=.5, m=1, and m=2, tend to produce the best on screen graphics. | |||||||||||
| rows=r | Specifies the number of rows for table object. | ||||||||||
| top=t | t is the vertical coordinate of the top edge of the object relative to the top edge of the paper. | ||||||||||
| trans=t |
| ||||||||||
| For trans =1 to be effective, the object itself must also be transparent. Annotations have their own transparent/opaque settings. Graphs are transparent only if their backgrounds are white. PICTs may have been created transparent or opaque, and Igor cannot make an opaque PICT transparent. | |||||||||||
| units=u | Sets dimension units in the layout info panel and in the Modify Objects dialog. | ||||||||||
| |||||||||||
| width=w | Sets the object width. | ||||||||||
Flags
| /I | Dimensions in inches. | |
| /M | Dimensions in centimeters. | |
| /W=winName | winName is the name of the page layout window to be modified. If /W is omitted or if winName is $"", the top page layout is modified. | |
| /Z | Does not generate an error if the indexed or named object does not exist in a style macro. | |
The /I and /M flags affect the units of the parameters for the left, top, width and height keywords only. If neither /I nor /M is present then the parameters for the left, top, width and height keywords are points.
Details
Note that the units keyword affects only the units used in the layout info panel and in the Modify Objects dialog. It has nothing to do with the units used for the left, top, width and height keywords. Those units are points unless the /I or /M flags is present.
See Also
NewLayout, AppendLayoutObject, RemoveLayoutObjects, LayoutPageAction