Display Boxes

Many display box messages, such as <<Set Text, automatically mark the box as invalid, so the <<Inval message is usually unnecessary. Some interactive scripts that use sliders with JSL callbacks may need <<Update Window to keep various parts of the display synchronized with the slider.

db<<Journal

Appends the box to the journal.

db<<Journal Window

Appends the containing window of the display box to the journal; compare with Journal.

db<<Move Window(x, y)

Moves the window to the (x,y) location on your screen.

db<<Page Break

Inserts a page break before the box.

db<<Parent

Returns the parent of this display box.

db<<Prepend(db2)

Add db2 to the display tree before db.

db<<Reshow

Invalidates the display box’s area in the window and immediate removes invalid areas from the window.

db<<Save Capture("path", <"format">, <Add Sibling(n)>)

Saves the display box as a graphic to the specified "path" in the specified "format". The optional Add Sibling argument adds the number of sibling display boxes to include in the capture. The default value is 1, which captures only the specified display box. Note that the specified portion of the report is not guaranteed to be scrolled into view or unobstructed by other windows. If the display box is not visible, the saved graphic will not contain the contents that you expect.

db<<Save HTML("" | "path", "format")

Saves HTML source and folder of graphics in "format" specified.

db<<Save Interactive HTML( "path" )

Saves the display box as a web page that includes interactive HTML 5 features. Non-JMP users can then explore the data.

Examples

biv = Bivariate( y( weight ), x( height ));

rbiv = (biv << report);

rbiv << Save Interactive HTML( "f:\MyInteractiveHTML.htm");

To include By groups, follow this example:

biv = Bivariate( y( weight ), x( height ));

Current Report() << Save Interactive HTML( "f:\MyInteractiveHTML.htm");

db<<Save Journal("" | "path")

Saves journal source for the box.

db<<Save MSWord("pathname", Native)

Saves the display box as a Microsoft Word document. (Windows Only)

db<<Save Picture("" | "pathname", "format")

Saves a picture of the box.

Notes

On Windows, the Windows Specific preferences determine the resolution (or DPI), or you can run the following script:

Pref( Save Image DPI( <number> ) );

On Macintosh, the operating system determines the DPI.

Saves display boxes in a Microsoft PowerPoint presentation. You can open the file in any presentation software program.

Arguments

path

The quoted location of the saved file. You must include the .pptx extension in the filename. An existing file with the same name is overwritten.

template

Optional. The quoted path name and file name of a custom PowerPoint template. Without this argument, JMP uses the default template located in the pptx folder of the installation directory.

Include a simple table in your template, or a default table format is applied to report tables. For an example on Windows, see /pptx/JMPExportTemplate.pptx in the JMP installation folder.

Insert

Optional. Determines where the slides are inserted in an existing presentation.

‒	n inserts the slides as the nth slide number.

‒	"Begin " inserts the slides at the beginning of the presentation.

‒	"End" inserts the slides at the end of the presentation.

Replace

Optional. Determines which slides are replaced in an existing presentation. The arguments are n, "Begin", and "End" as described for Insert.

Append

Optional. The slides are inserted at the end of an existing presentation.

Outline Titles

Optional. The location of the outline titles on the slide. By default, outline titles appear in the bottom left corner of the slide.

‒	"None" omits the slide title above the graphic and the outline titles.

‒	"Hide" omits the outline titles.

‒	"TopLeft", "TopRight", "BottomLeft", "BottomRight" determine the position of the outline titles on the slide. The outline title and its parent titles are included.

format

Optional. The quoted format of the embedded graphics. Options are "Native", "EMF", "PNG", "JPG", "BMP", "GIF", "TIF". On Windows, the native format is EMF. On Macintosh, the native format is PDF. See “Notes” for compatibility issues. Without this argument, JMP applies the “Image Format for PowerPoint” General preference.

Notes

Windows does not support the native PDF graphics produced on Macintosh. Macintosh does not support the native EMF graphics produced on Windows. For cross-platform compatibility, specify "PNG", "JPG", "GIF", or "TIF".

db<<Save RTF("" | "pathname", "format")

Saves RTF source with graphics in "format" specified.

db<<Save Text("" | "pathname", "format")

Saves a file containing the text of the box.

db<<Scroll Window(x, y)

Scrolls the containing window.

db<<Select

db<<Deselect

Selects (highlights) or deselects the box.

db<<Set Menu Item State(index, 0 | 1 | -1)

Sets the popup menu item at index to be normal (0), checked (1), or disabled (-1).

db<<Set Page Setup<margins(left, right, top, bottom)>, <scale(s)>,<portrait(Boolean)>, <paper size("paper"))

db<<Set Page Setup<margins({left, right, top, bottom})>, <scale(s)>,<portrait(Boolean)>, <paper size("paper"))

Sets the page settings. Margins are set in inches. Scale variable s is a number in the range of 10 (for 1000%) to 0.2 (for 20%) with the default as 1 (for 100%). If portrait is True the page is oriented for portrait, otherwise the page is landscape. Paper size is a string specifying the paper size, for example, "Letter" or "Legal".

Example

The example below creates a new window and configures the page setup.

w = New Window( "Window",

Text Box( "Page Setup Test" )

);

w << Set page setup(

margins( 1, 1, 1, 1 ),

scale( 1 ),

portrait( 1 ),

paper size( "Letter" )

);

db<<Set Submenu (index, submenu count)

Sets the submenu items for the item (specified by index number) by specifying the number of items in the submenu.

Example

The example below creates a menu containing “A”, “B”, and “C” with “A” having a submenu “A1” and “A2” and “B” having a submenu “B1”, “B2”, and “B3”.

New Window( "title", ob = Outline Box( "title" ) );

submenus = { };

ob << Set Menu Script(

{"A", "", "A1", Print( "A1" ), "A2", Print( "A2" ),

"B", "", "B1", Print( "B1" ), "B2", Print( "B2" ), "B3", Print( "B3" ),

"C", Print( "C" )}

);

ob << set submenu(1, 2); // menu A with 2 items in submenu A1 and A2

ob << set submenu(4, 3); // menu B with 3 items in submenu B1, B2, and B3

db<<Set Report Title("title")

Sets a new title.

Show Properties(db)

Shows the messages a given display box can interpret.

db<<Sib

Returns the sibling of the box.

db<<Sib Append(db2)

Appends a display as a sibling to this one. The argument must evaluate to a display box owner or reference.

db<<Size Window(x, y)

Resizes the containing window.

db<<Update Window

Updates the window that holds the display box (and possibly other windows as well, depending on the operating system) if there are invalidated regions. Previously invalidated box areas are redrawn with their new content.

Notes

In some interactive JSL scripts that combine sliders with JSL callbacks, you might need to use <<Update Window to keep parts of the display synchronized with the slider.

db<<Zoom Window

Resizes the window to be large enough to show all of its contents.

Axis Boxes

axis box<<Axis Settings(<named_arguments>)

Opens the axis specification window or specifies axis settings such as tick marks and axis labels.

If no arguments are included, the axis specification window appears.

Otherwise, specify named arguments for each axis.

‒	Specify the Y axis as axis box(1).

‒	Specify the X axis as axis box(2).

The following example creates a bivariate plot and defines settings for the X and Y axes.

Open( "$SAMPLE_DATA/Big Class.jmp" );

biv = Bivariate( X( :height ), Y( :weight ), FitLine );

rbiv = biv << report;

xaxis = rbiv[axis box( 2 )];

yaxis = rbiv[axis box( 1 )];

xaxis << Axis Settings( Show Major Grid( 1 ) );

yaxis << Axis Settings( Decimal( 10, 3 ) );

axis box<<Add Axis Label("string")

Adds an axis label with the specified string.

axis box<<Add Ref Line(number, "linestyle", <"color">, <"label">, <width>)

Adds a reference line at number in the linestyle ("Solid" | "Dashed" | "Double"), "color" (using "color name" or index number), "label", and width (in pixels) specified. Note: When a reference line is added that uses the same "label" as an existing reference line, the existing reference line is removed and the new line added.

axis box<<Decimal(width, decimalplaces)

Changes the numeric format for axis values.

axis box<<Format("name")

Changes to the numeric format given by "name".

axis box<<Get Inc(n)

Gets the increment value of the axis.

axis box<<Inc(n)

Sets the increment between ticks.

axis box<<Interval("format")

Specifies the units used for Inc() with date/time formats: "Numeric", "Year", "Quarter", "Month", "Week", "Day", "Hour", "Minute", or "Second".

axis box<<Label Orientation("format")

Description

Rotates the axis label to one of the following quoted formats: "Automatic" (based on the width of the label), "Horizonal", "Vertical", "Perpendicular", "Parallel", and "Angled".

axis box<<Major Grid Line Color("color")

Sets the color for the major grid (if enabled) using either the "color name" or index number.

axis box<<Max(max)

Changes the maximum value on the axis.

axis box<<Minor Grid Line Color("color")

Sets the color for the minor grid (if enabled) using either the "color name" or index number.

axis box<<Min(min)

Changes the minimum value on the axis.

axis box<<Minor Ticks(number)

Specifies the number of minor tick marks between major tick marks.

axis box<<Remove Axis Label

Removes any label added with Add Axis Label.

axis box<<Reverse Scale(Boolean)

Reverses the normal scale direction so that the highest value is on the left or bottom (that is, closest to the origin).

axis box<<Revert Axis

Restores the axis’ original settings (from time of creation).

axis box<<Scale("type")

If the type is Custom Scale, this message expects two additional clauses: Scale to Internal(expr) and Scale to External(expr).

axis box<<Tick Font("name", <size>, <"style" | "style style...">, "<angle>")

Sets the font name and properties for tick marks. To specify more than one style, include a space between each style and place them in quotes.

axis box<<Show Labels(Boolean)

Shows or hides labels for the axis values.

axis box<<Show Major Grid(Boolean)

Adds or removes grid lines at the major tick values.

axis box<<Show Major Ticks(Boolean)

Shows or hides major tick marks.

axis box<<Show Minor Grid(Boolean)

Adds or removes grid lines at the minor tick values.

axis box<<Show Minor Ticks(Boolean)

Shows or hides minor tick marks.

axis box<<Tick Label List(<i>, {"text1","text2", ...},{n1, n2, ...})

Sets the values and positions of the axis tick labels.

Note: Major tick increments are automatically set to 1.0.

The first (optional) integer, i, is the label row index. Leaving it out clears any existing label rows and creates one new one as specified. Including it allows you to override any particular label row; using an index higher than the current number of label rows adds a new label row on to the end.

The second list argument is the string titles for your labels.

The third list argument is optional and specifies the values corresponding to each label; if the value list is omitted, the labels will be on integer increments starting with 1.

Border Boxes

Note: Border boxes support only one display box argument.

border box<<Set Background Color( {R, G, B} | <"color">)

Sets the background color for a border box. Specify a "color name" or a list of RGB values. For example:

border box<<set background color("red");

border box<<set background color( {255, 192, 3} );

border box<<Set Color( {R, G, B} | <"color">)

Sets the border color for a border box. Specify a "color name" or a list of RGB values. For example:

border box<<set color("red");

border box<<Get Color

Gets the border color for a border box.

border box<<Set Style ("style")

Sets the border style for a border box. Specify the style as one of the following numbers or keywords: 0 ("Solid"), 1 ("Dotted"), 2 ("Dashed"), 3 ("DashDot"), or 4 ("DashDotDot"). For example:

border box<<Set Style("dotted");

border box<<Get Style

Gets the border style for a border box. For example:

border box<<Get Style;

Data Grid Boxes

dgb<<Set Data Table(<data_table>)

Sets the data table for the data grid box.

Frame Boxes

frame box<<Add Graphics Script(<order>,<"description">, <script>)

Description

Adds a script to draw graphics in the frame box.

Arguments

order

An optional argument that specifies the order in which the graphics elements are drawn. The value can be the keyword Back or Forward or an integer that specifies the drawing order for a number of graphics elements. 1 means the object is drawn first.

description

An optional string that appears in the Customize Graph window next to the graphics script.

script

An optional JSL script.

Example

In the following example, the graphics script draws the line first and then draws the other graphics elements: the grid lines, references lines, and markers that create the bivariate plot. Without the 1 order argument, the line is drawn last and covers up the markers.

dt = Open( "$SAMPLE_DATA/Big Class.jmp" );

obj = Bivariate( Y( :weight ), X( :height ) );

Report( obj )[FrameBox( 1 )] <<

Add Graphics Script(

1, // draws the line first

Description( "Pen Script" ),

Pen Color( "red" );

Pen Size( 5 );

Y Function( 60 + 120 / 2 * (1 + Sine( (2 * Pi() * (x - 50)) / 22.5 )), x );

);

frame box<<Append Seg

Adds a display seg to the specified Frame Box.

frame box<<Background Color( {R, G, B} | <"color">)

Changes the background color. Specify a "color name" or a list of RGB values.

frame box<<Child Seg

Returns the display seg child of the Frame Box.

frame box<<Edit Graphics Script

Brings up a dialog box to view, edit, or delete the current graphics scripts.

frame box<<Find Seg

Returns a display seg with the specified argument (for example, the name of a seg).

frame box<<Frame Size(x, y)

Resets the size of the frame, in pixel units.

frame box<<Make table of graphs like this

Creates a data table of graphs.

frame box<<Marker Size(size)

Changes the marker size.

frame box<<Row Colors(color)

frame box<<Row Markers(marker)

frame box<<Row Exclude

frame box<<Row Hide

frame box<<Row Label

Forwards commands to the data table associated with the report, so that the row states of selected rows can be manipulated. For <<Row Exclude, <<Row Hide, and <<Row Label, omitting the argument toggles the option. If the option is off, the message turns it on. If the option is on, the message turns it off.

frame box<<X Axis(min, max, inc, named arguments)

Scales the X coordinate system.

frame box<<Y Axis(min, max, inc, named arguments)

Scales the Y coordinate system.

Matrix Boxes

matrix box<<Get

Returns the matrix contents.

matrix box<<Make Into Data Table(<Invisible(Boolean)>)

Turns the matrix into a new data table. The optional argument Invisible(), if True, hides the data table from view but shows it in the Window List pane. If False, the Invisible() argument shows the data table and it is listed in the Window List pane.

matrix box<<Set Format(width, decimalplaces)

Sets the numeric format for matrix elements.

matrix box<<Sort(column_num, ascending_bool)

Sorts the rows of the matrix based on the column number specified by column_num. The default sort order is ascending.

If column_num is 0, the sort is removed.

If ascending_bool is "True", the sort is performed in ascending order. If ascending_bool is "False", the sort is in descending order.

Nom Axis Boxes

nom axis box<<Divider Lines(Boolean)

Adds or removes divider lines between labels in the axis box.

nom axis box<<Lower Frame(Boolean)

Adds or removes a lower frame around the axis.

nom axis box<<Rotated Tick Labels(Boolean)

Rotates or unrotates the labels at each tick value.

Number Col Boxes

number col box<<Add Element(item)

Adds the item to the Number Col Box. Item can be a single number, a list of numbers, or a matrix of numbers.

number col box<<Get

number col box<<Get(i)

Gets the values in a list, or the i th value.

number col box<<Get As Matrix

Gets the values in a matrix, specifically a column vector.

number col box<<Get Format

Returns the current format (width, decimalplaces). A decimalplaces > 100 indicates date/time values.

number col box<<Get Heading

Returns the column heading text.

number col box<<Set Format(width, decimalplaces)

number col box<<Set Format("format", width)

Sets the format. Set decimalplaces > 100 for date/time values. Set decimalplaces = 97 for p-value format.

For example,

<< Set Format( 10, 2)

<< Set Format( "Scientific", 10 )

number col box<<Set Heading("string")

Changes the column heading text.

Outline Boxes

outline box<<Close(Boolean)

Closes the outline box.

outline box<<Close All Below

Closes all the node’s child nodes.

outline box<<Close All Like This

Closes all nodes similar to this outline box.

outline box<<Close Where No Outlines

Closes all nodes that do not have children.

outline box<<Get Title

Gets the title of the outline box.

outline box<<Horizontal(Boolean)

Horizontally aligns the node’s children.

outline box<<Open All Below

Opens all the node’s child nodes.

outline box<<Open All Like This

Opens all nodes similar to this outline box.

outline box<<Set Menu Script({"string1", script1,"string2", script2, ...})

Adds an entry to the menu when the red triangle on an outline box is selected.

outline box<<Set Title("text")

Changes the title of the outline box.

Panel Boxes

panel box<<Get Title

Gets the title of the panel box.

panel box<<Set Title("text")

Changes the title of the panel box.

Plot Col Boxes

plot col box<<Get As Matrix

Gets the values in a matrix, specifically a column vector.

plot col box<<Set Values([matrix] or {list})

Sets values for the matrix (for numeric variables) or list (for character variables).

Slider Boxes and Range Slider Boxes

slider box<<Get(<index>)

range slider box<<Get Lower(<index>)

range slider box<<Get Upper(<index>)

Returns the current value of the slider.

slider box<<Set(n, <index>, <run script(0|1)>)

range slider box<<Set Lower(n, <index>, <run script(0|1)>)

range slider box<<Set Upper(n, <index>, <run script(0|1)>)

Sets the value of the slider. run script(0|1) controls whether an on-change script runs after the <<Set, <<Set Lower, or <<Set Upper message.

slider box<<Get Min()

Returns the minimum value possible for the range slider and slider.

slider box<<Set Min(float, <index>)

Sets the minimum value possible for the range slider and slider.

slider box<<Get Max()

Returns the maximum value possible for the range slider and slider.

slider box<<Get Var

range slider box<<Get Lower Var

range slider box<<Get Upper Var

Returns the variable name associated with the slider.

slider box<<Set Max(float, <index>)

Sets the maximum value possible for the range slider and slider.

slider box<<Set Script(<script>)

Sets a script to be run when the range sliders and slider is updated.

slider box<<Set Var(slider_var)

range slider box<<Set Lower Var(slider_var)

range slider box<<Set Upper Var(slider_var)

Sets the variable name associated with the slider.

String Col Boxes

string col box<<Add Element(item)

Adds the item to the String Col Box. Item can be a single quoted string, a list of quoted strings, or a matrix of quoted strings.

string col box<<Get

string col box<<Get(i)

Gets the values in a list, or the i th value.

string col box<<Get Heading

Returns the column heading text.

string col box<<Set Heading("text")

Changes the column heading text.

string col box<<Set Justify("right"|"left" |"center")

Specifies the alignment of the contents in the string col box to right, left, or center.

Tab Boxes

tab box<<Get Tab Margin()

Returns a list of the current margins in pixels for the tab box in this order: {left, top, right, bottom}.

Changes the appearance of the tab box from a tab to a combo box or outline node.

"vertical spread" and "horizontal spread" change the orientation of the tab title.

"minimize size" bases the tab style on the width of the tab title. See the Scripting Guide for an example.

tab box<<Set Tab Margin(n|{...})

Sets the tab margin for the tab box. If a single number is specified, all four margins are set to that number of pixels. If a list of two numbers is specified, the left and right margins are set to the first number, and the top and bottom margins are set to the second number. If a list of four numbers is specified, the margins are set in this order: {left, top, right, bottom}.

tab box<<Show Tabs(0|1)

Shows or hides the tabs for tab boxes. If you hide the tabs, you need to provide another way to select and show tabs. For example, a list box that contains a list of references to the tabs. The default value is 1.

Table Boxes

table box<<Get

Gets the entries of the table in list form.

table box<<Get As Matrix

Gets the numeric entries of the table in matrix form.

table box<<Get Locked Columns

Returns the number of columns that cannot be dragged with the hand cursor or have any columns dropped before them.

table box<<Get Row Change Function

Returns the expression that is evaluated when a row is selected.

table box<<Get Selectable Rows

Returns True if the table box currently allows row selection.

table box<<Get Selected Row Color

Returns the index number of the background color of the selected rows in the table box.

table box<<Make Combined Data Table

Same as Make Data Table, but also searches the report for report tables with the same columns and combine all of these into the new data table.

table box<<Make Data Table(name)

Turns the table entries into a new data table.

table box<<Set Row Change Function

Sets the expression that is evaluated when a row is selected.

table box<<Set Cell Changed Function(Function({this, col box, row},<script>;))

Sets a function that is called whenever the user edits a cell in a column in a table.

Example

This example prints the new values for the changed cell to the log.

Names Default To Here( 1 );

New Window( "Mountains",

tb = Table Box(

String Col Edit Box(

"Mountain",

{"K2", "Delphi", "Kilimanjaro",

"Grand Teton"}

Number Col Edit Box(

"Elevation (meters)",

{8611, 681, 5895, 4199}

Plot Col Box( "", {8611, 681, 5895, 4199} )

)

);

tb <<

Set Cell Changed Function(

Function( {this, col, row},

Print(

(col << get heading) || ": row:" ||

Char( 3 ) || " is now " ||

Char( col << get( row ) )

)

);

table box<<Set Locked Columns(n)

Locks the first n columns. You cannot drag the locked columns or drag columns before them.

table box<<Set Selectable Rows(Boolean)

Makes the rows of the Table Box selectable or not.

table box<<Set Selected Row Color("color")

If the rows of the Table Box are selectable (Set Selectable Rows(True)), sets the background color for the selected rows.

Text Boxes

text box<<Font Color(n)

Sets the color for Text strings.

text box<<Get Hidden State

Returns the current state of a text box.

text box<<Get Text

Returns the string content of the box.

text box<<Get Tip

Returns the tooltip for the text box (or a text edit box).

text box<<Markup

Returns text formatted with the specified HTML tags. The HTML must be well-formed; make sure you close nested tags correctly.

The following example returns text formatted in bold, italic, and underlined.

w = New Window("Formatted Text",

Text Box("This is <b>bold</b> text. This is <b><i>bold italic</i></b> text. This is <u>underlined</u> text.",

<<Markup) );

text box<<Rotate Text("direction")

Rotates the text 90 degrees "left" or "right", or returns it to the horizontal.

text box<<Set Font("name", <size>, <style | "style style...">, <angle>)

Sets the font name and properties for text strings. To specify more than one style, include a space between each style and place them in quotes.

text box<<Set Font Size(n)

Sets the font size in points for text strings.

text box<<Set Font Style("style" | "style style...")

Sets the font style for text strings. To specify more than one style, include a space between each style and place them in quotes. Integers are backwards compatible but not recommended for new scripts.

text box<<Set Script(script)

Associate a script to a text box. The script executes when the user hits enter (or the text edit box otherwise loses focus).

text box<<Set Text("string")

Changes the string content of the box.

text box<<Set Tip("string")

Sets the tooltip for the text box (or a text edit box).

text box<<Set Wrap(n)

Set the wrap point, in pixels, in pixels (n).

Windows

window<<Bring Window to Front

Brings the window to the front.

window<<Close Window(<nosave>)

Closes the window. If the optional argument nosave is specified, the window (journal, project, and so forth) is closed without saving or prompting.

window<<Get Content Size

Returns the size of the window’s contents.

window<<Get Window Icon

Returns the name of the window’s icon.

window<<Get Window Position

Returns the position of the window.

window<<Get Window Size

Returns the size of the window.

window<<Get Window Title

Returns the title of the window.

window<<Inval

Invalidate the display box. The window updates either when the <<Update Window message is sent or when the operating system has time for the update. See <<Reshow for another method.

window<<Maximize Display

Maximizes the window.

window<<Maximize Window

Maximizes the window.

window<<Minimize Window

Minimizes the window.

window<<Move Window(x, y)

Moves the window to the specified position.

window<<On Close(script)

Runs the script when the window is closed.

window<<Pad Window(Boolean)

Turns padding around a window’s contents on (1) or off (0). The default value is off.