3.3.2.45 Page


Perform various operations on the current page.

Contents

Syntax:

page [option]

Options:

no option; Open the page tabs of Plot Details dialog

Open the Plot Details dialog box with the page tabs active.

-af; Change Scale Factor of all layers in a graph page to a specified value

Syntax: page -af value

Change Scale Factor of all layers in a graph page to a specified value, if not already so. This change will apply the scale change to all objects of the layers, including the axes, axes labels, legend, data plots, and other objects attached to the Layer Frame or Layer and Scales. And it will affect elements including text font size, line width of lines and arrows, dimensions of arrow heads and tails and line width of drawn objects such as Rectangles, Polylines, etc.

-afu; Change Scale Factor of all layers in a graph page to a specified value, Undo Supported

Syntax: page -afu value

Change Scale Factor of all layers in a graph page to a specified value. The difference between -af and -afu is that -afu supports undo.

-c; Open the Page Color dialog box

Syntax: page -c

Open the Page Color dialog box.

-f; Adjust the page dimensions according to the current windows aspect ratio

Syntax: page -f

Adjust the page dimensions to fit the current window aspect ratio.

-fls; Fit layers to page

Syntax: page -fls [-m [marginsvalue]] [-l [gapvalue]] [-a] [-u]

Adjust layer dimensions to fit page size, with the following options:

Option Description
-m marginsvalue Specifies the margin around the edges of the page. The value marginsvalue is a decimal -- not a percentage (e.g. 0.05 not 5) -- of page size in the shorter dimension. The marginsvalue can be omitted, in which case, it will be assumed to be 0 (i.e. margin = "tight").
-l gapvalue Place legend to the right side of the graph, outside of the layer, adjusted by optional gapvalue. The value gapvalue is a decimal -- not a percentage (e.g. 0.05 not 5) -- of page size in the shorter dimension. The gapvalue can be omitted, in which case, it will be assumed to be 0.
To use the -l option, the following must be true:
  • Graph contains a single layer.
  • There is one (and only one) legend object.
  • Scale Elements (Format: Layer > Display tab) must be Fixed Factor.
-a specifies to preserve the aspect ratio. If not present, the aspect ratio is not preserved.
-u Adjust layer dimensions without UNDO.

-j; Convert each layer of a multiple layer graph into a graph window

Syntax: page -j

Convert a multiple layer graph into multiple graph windows in which each layer displays in its own graph window.

-l; Add the specified template to the active graph window

Syntax: page -l templateName

Read the specified template file and add all of its layers to the page in the active graph window.

-lt; print the current protection bits

Syntax: page -lt

Minimum Origin Version Required: 9.1 SR0

-lw; Turn on protection on workbook level

Syntax: page -lw hex(hex value)

Minimum Origin Version Required: 9.1 SR0

Hex value Description
-- Turn on all protection bits.
0 Remove all the protections on active workbook.
2 Data Protection: This include all cells in a worksheet (data cells and label cells).
80 Structure Protection: Keep the columns in the sheet unchanged. Prevent insert/delete of columns or moving of columns. However, allow rows to be changed. Prevent insert/delete of worksheets or moving of worksheets.
400 Delete Protection: Prevent the workbook from being deleted. The book can only be hidden.
Note: Multiple protection flags can be applied (values are additive).
newbook;
page -lw hex(482); //Prevent editing of data, modifying of structure or deletion of the active workbook.

-mg Origin_modified_state; Get the modified state of the active window

Syntax: page -mg Origin_modified_state

Get the modified state of the active window and output into variable Origin_modified_state, Origin_modified_state = 1 if modified, 0 if not modified.

-ms; clear the modified state

Syntax: page -ms

Clear the modified state for active window.

-o; Set the page to portrait, landscape, or rotate the page

Syntax: page -o type, where

  • portrait, type = p
  • landscape, type = l
  • rotate the page, type = r

Set the page to portrait, landscape, or rotate the page.

Note: When used to change Master Template orientation, this command also changes the Master Template window Short Name (portrait = "Portrait", landscape = "Master").

-pg; Get page related parameters

Syntax: page -pg type varName

Get page related parameters to varName. About the type, please see the table in next option.

-ps; Set page related parameters

Syntax: page -ps type value

Set page related parameters.

Note on type

C -- Closing flags: 0 = normal, 1 = no close, and 2 = no warning.

D -- Document closing method. When value = 1, set the active window as a system window which remains open when the project is closed. In addition, this window is not saved with the project. For related information on the page.syswin object property, see the page object.

H -- Height of the page in dots. For a graph window, this value is the number of dots from the top to the bottom of the page. For a worksheet window, this number is the vertical screen resolution in pixels.

P -- Maximum show points: 0 = show all data points.

S -- Search flags.

bit(n) value(2^n) disable search on
0 1 axis
1 2 data plot
2 4 label
3 8 graphical object
4 6 layer frame
5 32 tick labels

W -- Width of the page in dots. For a graph window, this value is the number of dots across the page. For a worksheet window, this number is the horizontal screen resolution in pixels.

-rrt; Connect the table objects on an active graph page

Syntax: page -rrt

Connect the table objects on an active graph page after loading a project. You have to manually refresh graphs after this to see table objects.

-s; Select the specified object on the page

Syntax: page -s object

Select the specified object on the page. If no object is given, this command clears the current selection.

-sa; Select the specified object on the page and preserve the status of all current objects

Syntax: page -sa object

Select the specified object on the page, leaving the status of other current objects.

-t; Open the specified template using the active graph window

Syntax: page -t templateName

Replace the page in the active graph window with the template templateName, without closing the active graph window.All current layers are deleted. Similar to the document -t and window -t commands (document -t lets you specify a complete path).

-tbb; Add Labtalk Button to Window Title Bar

Minimum Origin Version Required: 9.0 SR0

This command adds a small system button to the active window, in front of the minimize button. This allows a LabTalk script to be attached to a window/page.

SynTax: page -tbb n [script [tooltip]]

where n can be 0,1,2,3

n Meaning
0 Remove the button, subsequent script etc is ignored
1,2 Add a button with the right-arrow icon
3 Add a button with the Home icon

script and tooltip must both be quoted. Example:

page -tbb 3 "run.section(%XMyTest.ogs,Main)" "Run my Labtalk code to do something";

-uo; Update Operations

Syntax: page -uo

(SR1) Dirty all the operations which input intersects with the active page.

-us; Update active Excel book to recreate all hidden Origin sheets with all the Excel data copied over

Syntax: page -us

(SR1) Update active Excel book to recreate all hidden Origin sheets with all the Excel data copied over. This is similar to the layer -s command which acts only on the active Excel sheet.

-v; Set the page to the specified view mode

Syntax: page -v n

Set the page to the specified view mode.0 = Print view, 1 = Page View, 2 = Window View, and 3 = Draft View.

-vx; Switch the view mode for the active Excel workbook

Syntax: page -vx

Switch between the workbook view and the hidden Origin worksheet layer view for the active Excel workbook in Origin.

-w; Plot each column in the worksheet to separate graph layers

SynTax: page -w wksName c1 r1 c2 r2 [ID]

Plot each column in the worksheet to separate graph layers.Same as the layer -wcommand but put each dataset (column) into separate layers in the page. When the last layer is passed, cycles back to the first layer. Note: An active graph window with the correct number of layers must already exist.

-x; Add the active window as shortcut to Favorites folder

Syntax: page -x

Add a shortcut to the window, to the project Favorites folder (example, below). If the folder does not exist, create it.

-yt; Draw the tight rectangles for each layer

Minimum Origin Version Required: 2019

Syntax: page -yt

Draw the tight rectangles for each layer as these tight rectangles are used during the layer arrangement. You can also add the switch -d to dump the numeric values:

page -yt -d;

Examples:

The following script disables the search on axes and labels for the page.

page -ps search 1;

Note: You can also use: page.noclick = 5;

The next script doubles the maximum display points for the page.

page -pg p npts; page -ps p (npts*2);

Note:

You can also use: page.maxpts *= 2;

The next script adds the layer from the scatter template to the page

page -l Scatter;

The following script makes graph1 the active window. It saves graph1 as a system window which remains open when the project is closed. However, graph1 will not be saved with the project.

win -a graph1;
page -ps d 1;

This script loops through all workbooks in the project, searches for those with "CC" in the name and adds those as shortcuts to a Favorites folder.

doc -e W {
		if (search(page.name$,"CC")>0) 
		{
			page.name$=;
			page -X;
		}
	}