General Messages for Platform Windows

The Save Script commands are applicable to almost all of the platforms. Some additional commands are shown in Messages that can be sent to platform windows. In particular the Report command lets you access the display surface to control appearance details such as window zooming, scrolling, and so on. For example, to close an outline node for a report, you first obtain a reference to the Display Box tree, subscript to navigate to the outlineBox, and then send it the close message:

r = platformRef << Report;

r["Summary of Fit"] << close;

This is discussed in greater detail in Manipulating Displays in Display Trees.

Scripting Analysis Platforms
Goal	Command	Explanation
See available messages	Show Properties(obj)	Shows the messages that a given object can interpret, along with some basic syntax information. Works with all scriptable objects, not just platforms.
Send message	obj << message Send(obj, message)	Sends a message to a platform object.
Send several messages	obj << message << message... obj << {message, message, ...}	Sends a series of messages (in order, left to right) to the platform object.
Send message to child	obj << ( child << message )	Sends a message to a child object within a platform object.
Suppressing output	Platform name(...,invisible)	Keeps output from a report from displaying on-screen. With Fit Model, both the model window and report are suppressed.
Changing a report’s title	Platform name (...,title(“string”))	Changes the report title to string. The By variable is appended to the title when necessary.
Changing the automatic recalc setting	Platform name (...,automatic recalc(Boolean))	True (1) sets automatic recalc on, so that any changes in the data or in the excluded state are immediately reflected in the report. False (0) sets automatic recalc off, so you must use redo analysis to see the changes. Note: If automatic recalc is on, you should use wait(0) commands to let the triggers to take effect and do the recalculation.
Suppressing the current platform preference settings	Platform name (Ignore Platform Preference (Boolean))	True (1) ensures that the current platform preference settings are not applied. False (0) means that the current platform preference settings will be applied.

Messages that can be sent to platform windows
Message	Syntax	Explanation
Redo Analysis	obj<<Redo Analysis	Launches the platform again with the same options.
Save Script to Data Table	obj<<Save Script to Data Table	Saves script to reproduce analysis as a property in the associated data table.
Save Script to Report	obj<<Save Script to Report	Saves script to reproduce analysis as a text box at the top of the report.
Save Script to Script Window	obj<<Save Script to Script Window	Saves script to reproduce analysis in the Script Journal window.
Save Script for All Objects	obj<<Save Script for All Objects	Saves script to reproduce all analyses found within the object’s window in the Script Journal window.
Get Script	x = obj<<Get Script	Returns script to reproduce the analysis as an expression.
Data Table Window	obj<<Data Table Window	Makes the associated data table window active (frontmost).
Close Window	obj<<Close Window	Closes the window identified by the obj, typically a platform surface.
Move Window	obj<<Move Window(x, y)	Moves the window to the (x,y) location on your screen.
Show Window	obj<<Show Window(1)	Shows the identified window.
Zoom Window	obj<<Zoom Window	Resizes the window to the maximum size of its contents.
Scroll Window	obj<<Scroll Window(x, y) obj<<Scroll Window({x, y})	Scrolls the window x pixels to the left and y pixels down from the current position; negative coordinates go right and up. If the coordinates are a list in braces { }, they are absolute coordinates. The window scrolls to the point x pixels from the left and y pixels from the top.
Bring Window to Front	obj<<Bring Window To Front	Brings the identified window to the front.
Size Window	obj<<Size Window(x, y)	Resizes the window to x pixels wide by y pixels high.
Maximize Window	obj<<Maximize Window	Maximizes the window; equivalent to clicking the maximize button in the upper right corner of the window. This message takes an optional Boolean argument: // maximize the window: obj<<Maximize Window(1) // restore the window: obj<<Maximize Window(0)
Minimize Window	obj<<Minimize Window	Minimizes the window; equivalent to clicking the minimize button in the upper right corner of the window. This message takes an optional Boolean argument: // minimize the window: obj<<Minimize Window(1) // restore the window: obj<<Minimize Window(0)
Print Window	obj<<Print Window	Prints the selected window.
Get Window Size	obj<<Get Window Size	Gets the size of the selected object. Returns an ordered pair showing width and height.
Get Window Position	obj<<Get Window Position	Gets the position of the selected object. Returns an ordered pair.
Report TopReport	obj<<Report Report(obj)	Returns a display box reference for the report in the platform window. See Display Box Object References in Display Trees for a discussion. TopReport goes to the top display box, and is useful for BY groups or other cases when several platform reports are in one window.
Journal Window	obj<<Journal Window	Appends the contents of the window to the journal.

Options for All Platforms

Almost all platforms support the BY argument in the launch command, so By is not documented separately for each platform. See BY Group Reports, for a general discussion.

Title

You can use a Title command across all platforms, which replaces the standard title. For example,

Bivariate (X(height), Y(weight), Title(“my title”));

Axes

For platforms that include graphs, you can customize the axes within the platform script. Options specific to the graphs in each platform are listed.

Automatic Recalculation

If automatic recalc is on, you should use wait(0) commands to let the triggers take effect and do the recalculation.